public final class CertificateAuthority extends GeneratedMessageV3 implements CertificateAuthorityOrBuilder
A CertificateAuthority represents an individual Certificate Authority.
A CertificateAuthority can be used to create Certificates.
Protobuf type google.cloud.security.privateca.v1.CertificateAuthority
Static Fields
ACCESS_URLS_FIELD_NUMBER
public static final int ACCESS_URLS_FIELD_NUMBER
Field Value
CA_CERTIFICATE_DESCRIPTIONS_FIELD_NUMBER
public static final int CA_CERTIFICATE_DESCRIPTIONS_FIELD_NUMBER
Field Value
CONFIG_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
Field Value
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
GCS_BUCKET_FIELD_NUMBER
public static final int GCS_BUCKET_FIELD_NUMBER
Field Value
KEY_SPEC_FIELD_NUMBER
public static final int KEY_SPEC_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
LIFETIME_FIELD_NUMBER
public static final int LIFETIME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PEM_CA_CERTIFICATES_FIELD_NUMBER
public static final int PEM_CA_CERTIFICATES_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
SUBORDINATE_CONFIG_FIELD_NUMBER
public static final int SUBORDINATE_CONFIG_FIELD_NUMBER
Field Value
TIER_FIELD_NUMBER
public static final int TIER_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static CertificateAuthority getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static CertificateAuthority.Builder newBuilder()
Returns
newBuilder(CertificateAuthority prototype)
public static CertificateAuthority.Builder newBuilder(CertificateAuthority prototype)
Parameter
Returns
public static CertificateAuthority parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static CertificateAuthority parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static CertificateAuthority parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CertificateAuthority parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static CertificateAuthority parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CertificateAuthority parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CertificateAuthority parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static CertificateAuthority parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CertificateAuthority parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static CertificateAuthority parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static CertificateAuthority parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CertificateAuthority parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<CertificateAuthority> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. Labels with user-defined metadata.
map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAccessUrls()
public CertificateAuthority.AccessUrls getAccessUrls()
Output only. URLs for accessing content published by this CA, such as the CA certificate
and CRLs.
.google.cloud.security.privateca.v1.CertificateAuthority.AccessUrls access_urls = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getAccessUrlsOrBuilder()
public CertificateAuthority.AccessUrlsOrBuilder getAccessUrlsOrBuilder()
Output only. URLs for accessing content published by this CA, such as the CA certificate
and CRLs.
.google.cloud.security.privateca.v1.CertificateAuthority.AccessUrls access_urls = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCaCertificateDescriptions(int index)
public CertificateDescription getCaCertificateDescriptions(int index)
Output only. A structured description of this CertificateAuthority's CA certificate
and its issuers. Ordered as self-to-root.
repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Name |
Description |
index |
int
|
Returns
getCaCertificateDescriptionsCount()
public int getCaCertificateDescriptionsCount()
Output only. A structured description of this CertificateAuthority's CA certificate
and its issuers. Ordered as self-to-root.
repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCaCertificateDescriptionsList()
public List<CertificateDescription> getCaCertificateDescriptionsList()
Output only. A structured description of this CertificateAuthority's CA certificate
and its issuers. Ordered as self-to-root.
repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCaCertificateDescriptionsOrBuilder(int index)
public CertificateDescriptionOrBuilder getCaCertificateDescriptionsOrBuilder(int index)
Output only. A structured description of this CertificateAuthority's CA certificate
and its issuers. Ordered as self-to-root.
repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Name |
Description |
index |
int
|
Returns
getCaCertificateDescriptionsOrBuilderList()
public List<? extends CertificateDescriptionOrBuilder> getCaCertificateDescriptionsOrBuilderList()
Output only. A structured description of this CertificateAuthority's CA certificate
and its issuers. Ordered as self-to-root.
repeated .google.cloud.security.privateca.v1.CertificateDescription ca_certificate_descriptions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type |
Description |
List<? extends com.google.cloud.security.privateca.v1.CertificateDescriptionOrBuilder> |
|
getConfig()
public CertificateConfig getConfig()
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns
getConfigOrBuilder()
public CertificateConfigOrBuilder getConfigOrBuilder()
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which this CertificateAuthority was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which this CertificateAuthority was created.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getDefaultInstanceForType()
public CertificateAuthority getDefaultInstanceForType()
Returns
getDeleteTime()
public Timestamp getDeleteTime()
Output only. The time at which this CertificateAuthority was soft deleted, if
it is in the DELETED state.
.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. The time at which this CertificateAuthority was soft deleted, if
it is in the DELETED state.
.google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getExpireTime()
public Timestamp getExpireTime()
Output only. The time at which this CertificateAuthority will be permanently purged,
if it is in the DELETED state.
.google.protobuf.Timestamp expire_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder()
Output only. The time at which this CertificateAuthority will be permanently purged,
if it is in the DELETED state.
.google.protobuf.Timestamp expire_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getGcsBucket()
public String getGcsBucket()
Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will
publish content, such as the CA certificate and CRLs. This must be a bucket
name, without any prefixes (such as gs://
) or suffixes (such as
.googleapis.com
). For example, to use a bucket named my-bucket
, you
would simply specify my-bucket
. If not specified, a managed bucket will
be created.
string gcs_bucket = 11 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type |
Description |
String |
The gcsBucket.
|
getGcsBucketBytes()
public ByteString getGcsBucketBytes()
Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will
publish content, such as the CA certificate and CRLs. This must be a bucket
name, without any prefixes (such as gs://
) or suffixes (such as
.googleapis.com
). For example, to use a bucket named my-bucket
, you
would simply specify my-bucket
. If not specified, a managed bucket will
be created.
string gcs_bucket = 11 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type |
Description |
ByteString |
The bytes for gcsBucket.
|
getKeySpec()
public CertificateAuthority.KeyVersionSpec getKeySpec()
Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this
CertificateAuthority is a self-signed CertificateAuthority, this key
is also used to sign the self-signed CA certificate. Otherwise, it
is used to sign a CSR.
.google.cloud.security.privateca.v1.CertificateAuthority.KeyVersionSpec key_spec = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns
getKeySpecOrBuilder()
public CertificateAuthority.KeyVersionSpecOrBuilder getKeySpecOrBuilder()
Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this
CertificateAuthority is a self-signed CertificateAuthority, this key
is also used to sign the self-signed CA certificate. Otherwise, it
is used to sign a CSR.
.google.cloud.security.privateca.v1.CertificateAuthority.KeyVersionSpec key_spec = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Optional. Labels with user-defined metadata.
map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];
Returns
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. Labels with user-defined metadata.
map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];
Returns
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. Labels with user-defined metadata.
map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];
Parameters
Returns
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. Labels with user-defined metadata.
map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Returns
getLifetime()
public Duration getLifetime()
Required. Immutable. The desired lifetime of the CA certificate. Used to create the
"not_before_time" and "not_after_time" fields inside an X.509
certificate.
.google.protobuf.Duration lifetime = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns