Class CertificateAuthority.Builder (2.47.0) 

public static final class CertificateAuthority.Builder extends GeneratedMessageV3.Builder<CertificateAuthority.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CertificateAuthority.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllCaCertificateDescriptions(Iterable<? extends CertificateDescription> values)

public CertificateAuthority.Builder addAllCaCertificateDescriptions(Iterable<? extends CertificateDescription> values)

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
values Iterable<? extends com.google.cloud.security.privateca.v1.CertificateDescription>
Returns
Type Description
CertificateAuthority.Builder

addAllPemCaCertificates(Iterable<String> values)

public CertificateAuthority.Builder addAllPemCaCertificates(Iterable<String> values)

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The pemCaCertificates to add.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

addCaCertificateDescriptions(CertificateDescription value)

public CertificateAuthority.Builder addCaCertificateDescriptions(CertificateDescription value)

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
value CertificateDescription
Returns
Type Description
CertificateAuthority.Builder

addCaCertificateDescriptions(CertificateDescription.Builder builderForValue)

public CertificateAuthority.Builder addCaCertificateDescriptions(CertificateDescription.Builder builderForValue)

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
builderForValue CertificateDescription.Builder
Returns
Type Description
CertificateAuthority.Builder

addCaCertificateDescriptions(int index, CertificateDescription value)

public CertificateAuthority.Builder addCaCertificateDescriptions(int index, CertificateDescription value)

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];

Parameters
Name Description
index int
value CertificateDescription
Returns
Type Description
CertificateAuthority.Builder

addCaCertificateDescriptions(int index, CertificateDescription.Builder builderForValue)

public CertificateAuthority.Builder addCaCertificateDescriptions(int index, CertificateDescription.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue CertificateDescription.Builder
Returns
Type Description
CertificateAuthority.Builder

addCaCertificateDescriptionsBuilder()

public CertificateDescription.Builder addCaCertificateDescriptionsBuilder()

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
CertificateDescription.Builder

addCaCertificateDescriptionsBuilder(int index)

public CertificateDescription.Builder addCaCertificateDescriptionsBuilder(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
Type Description
CertificateDescription.Builder

addPemCaCertificates(String value)

public CertificateAuthority.Builder addPemCaCertificates(String value)

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The pemCaCertificates to add.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

addPemCaCertificatesBytes(ByteString value)

public CertificateAuthority.Builder addPemCaCertificatesBytes(ByteString value)

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the pemCaCertificates to add.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CertificateAuthority.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CertificateAuthority.Builder
Overrides

build()

public CertificateAuthority build()
Returns
Type Description
CertificateAuthority

buildPartial()

public CertificateAuthority buildPartial()
Returns
Type Description
CertificateAuthority

clear()

public CertificateAuthority.Builder clear()
Returns
Type Description
CertificateAuthority.Builder
Overrides

clearAccessUrls()

public CertificateAuthority.Builder clearAccessUrls()

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
Type Description
CertificateAuthority.Builder

clearCaCertificateDescriptions()

public CertificateAuthority.Builder clearCaCertificateDescriptions()

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
CertificateAuthority.Builder

clearConfig()

public CertificateAuthority.Builder clearConfig()

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
Type Description
CertificateAuthority.Builder

clearCreateTime()

public CertificateAuthority.Builder clearCreateTime()

Output only. The time at which this CertificateAuthority was created.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.Builder

clearDeleteTime()

public CertificateAuthority.Builder clearDeleteTime()

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
Type Description
CertificateAuthority.Builder

clearExpireTime()

public CertificateAuthority.Builder clearExpireTime()

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
Type Description
CertificateAuthority.Builder

clearField(Descriptors.FieldDescriptor field)

public CertificateAuthority.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CertificateAuthority.Builder
Overrides

clearGcsBucket()

public CertificateAuthority.Builder clearGcsBucket()

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
CertificateAuthority.Builder

This builder for chaining.

clearKeySpec()

public CertificateAuthority.Builder clearKeySpec()

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
Type Description
CertificateAuthority.Builder

clearLabels()

public CertificateAuthority.Builder clearLabels()
Returns
Type Description
CertificateAuthority.Builder

clearLifetime()

public CertificateAuthority.Builder clearLifetime()

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
Type Description
CertificateAuthority.Builder

clearName()

public CertificateAuthority.Builder clearName()

Output only. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CertificateAuthority.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CertificateAuthority.Builder
Overrides

clearPemCaCertificates()

public CertificateAuthority.Builder clearPemCaCertificates()

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

clearState()

public CertificateAuthority.Builder clearState()

Output only. The State for this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

clearSubordinateConfig()

public CertificateAuthority.Builder clearSubordinateConfig()

Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

.google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CertificateAuthority.Builder

clearTier()

public CertificateAuthority.Builder clearTier()

Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

clearType()

public CertificateAuthority.Builder clearType()

Required. Immutable. The Type of this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.Type type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

clearUpdateTime()

public CertificateAuthority.Builder clearUpdateTime()

Output only. The time at which this CertificateAuthority was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.Builder

clone()

public CertificateAuthority.Builder clone()
Returns
Type Description
CertificateAuthority.Builder
Overrides

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
Name Description
key String
Returns
Type Description
boolean

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
Type Description
CertificateAuthority.AccessUrls

The accessUrls.

getAccessUrlsBuilder()

public CertificateAuthority.AccessUrls.Builder getAccessUrlsBuilder()

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
Type Description
CertificateAuthority.AccessUrls.Builder

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
Type Description
CertificateAuthority.AccessUrlsOrBuilder

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
Type Description
CertificateDescription

getCaCertificateDescriptionsBuilder(int index)

public CertificateDescription.Builder getCaCertificateDescriptionsBuilder(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
Type Description
CertificateDescription.Builder

getCaCertificateDescriptionsBuilderList()

public List<CertificateDescription.Builder> getCaCertificateDescriptionsBuilderList()

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<Builder>

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
Type Description
int

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
Type Description
List<CertificateDescription>

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
Type Description
CertificateDescriptionOrBuilder

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
Type Description
CertificateConfig

The config.

getConfigBuilder()

public CertificateConfig.Builder getConfigBuilder()

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
Type Description
CertificateConfig.Builder

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
Type Description
CertificateConfigOrBuilder

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
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time at which this CertificateAuthority was created.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

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
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public CertificateAuthority getDefaultInstanceForType()
Returns
Type Description
CertificateAuthority

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
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

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
Type Description
Builder

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
Type Description
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
Timestamp

The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

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
Type Description
Builder

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
Type Description
TimestampOrBuilder

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
Type Description
CertificateAuthority.KeyVersionSpec

The keySpec.

getKeySpecBuilder()

public CertificateAuthority.KeyVersionSpec.Builder getKeySpecBuilder()

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
Type Description
CertificateAuthority.KeyVersionSpec.Builder

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
Type Description
CertificateAuthority.KeyVersionSpecOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels with user-defined metadata.

map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels with user-defined metadata.

map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

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
Name Description
key String
defaultValue String
Returns
Type Description
String

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
Name Description
key String
Returns
Type Description
String

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
Type Description
Duration

The lifetime.

getLifetimeBuilder()

public Duration.Builder getLifetimeBuilder()

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
Type Description
Builder

getLifetimeOrBuilder()

public DurationOrBuilder getLifetimeOrBuilder()

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
Type Description
DurationOrBuilder

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Output only. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getPemCaCertificates(int index)

public String getPemCaCertificates(int index)

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The pemCaCertificates at the given index.

getPemCaCertificatesBytes(int index)

public ByteString getPemCaCertificatesBytes(int index)

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the pemCaCertificates at the given index.

getPemCaCertificatesCount()

public int getPemCaCertificatesCount()

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of pemCaCertificates.

getPemCaCertificatesList()

public ProtocolStringList getPemCaCertificatesList()

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the pemCaCertificates.

getState()

public CertificateAuthority.State getState()

Output only. The State for this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.State

The state.

getStateValue()

public int getStateValue()

Output only. The State for this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getSubordinateConfig()

public SubordinateConfig getSubordinateConfig()

Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

.google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SubordinateConfig

The subordinateConfig.

getSubordinateConfigBuilder()

public SubordinateConfig.Builder getSubordinateConfigBuilder()

Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

.google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SubordinateConfig.Builder

getSubordinateConfigOrBuilder()

public SubordinateConfigOrBuilder getSubordinateConfigOrBuilder()

Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

.google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SubordinateConfigOrBuilder

getTier()

public CaPool.Tier getTier()

Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CaPool.Tier

The tier.

getTierValue()

public int getTierValue()

Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for tier.

getType()

public CertificateAuthority.Type getType()

Required. Immutable. The Type of this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.Type type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateAuthority.Type

The type.

getTypeValue()

public int getTypeValue()

Required. Immutable. The Type of this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.Type type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time at which this CertificateAuthority was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time at which this CertificateAuthority was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which this CertificateAuthority was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAccessUrls()

public boolean hasAccessUrls()

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
Type Description
boolean

Whether the accessUrls field is set.

hasConfig()

public boolean hasConfig()

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
Type Description
boolean

Whether the config field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which this CertificateAuthority was created.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

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
Type Description
boolean

Whether the deleteTime field is set.

hasExpireTime()

public boolean hasExpireTime()

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
Type Description
boolean

Whether the expireTime field is set.

hasKeySpec()

public boolean hasKeySpec()

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
Type Description
boolean

Whether the keySpec field is set.

hasLifetime()

public boolean hasLifetime()

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
Type Description
boolean

Whether the lifetime field is set.

hasSubordinateConfig()

public boolean hasSubordinateConfig()

Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

.google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the subordinateConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time at which this CertificateAuthority was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAccessUrls(CertificateAuthority.AccessUrls value)

public CertificateAuthority.Builder mergeAccessUrls(CertificateAuthority.AccessUrls value)

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];

Parameter
Name Description
value CertificateAuthority.AccessUrls
Returns
Type Description
CertificateAuthority.Builder

mergeConfig(CertificateConfig value)

public CertificateAuthority.Builder mergeConfig(CertificateConfig value)

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];

Parameter
Name Description
value CertificateConfig
Returns
Type Description
CertificateAuthority.Builder

mergeCreateTime(Timestamp value)

public CertificateAuthority.Builder mergeCreateTime(Timestamp value)

Output only. The time at which this CertificateAuthority was created.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
CertificateAuthority.Builder

mergeDeleteTime(Timestamp value)

public CertificateAuthority.Builder mergeDeleteTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CertificateAuthority.Builder

mergeExpireTime(Timestamp value)

public CertificateAuthority.Builder mergeExpireTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CertificateAuthority.Builder

mergeFrom(CertificateAuthority other)

public CertificateAuthority.Builder mergeFrom(CertificateAuthority other)
Parameter
Name Description
other CertificateAuthority
Returns
Type Description
CertificateAuthority.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CertificateAuthority.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CertificateAuthority.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CertificateAuthority.Builder
Overrides

mergeKeySpec(CertificateAuthority.KeyVersionSpec value)

public CertificateAuthority.Builder mergeKeySpec(CertificateAuthority.KeyVersionSpec value)

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];

Parameter
Name Description
value CertificateAuthority.KeyVersionSpec
Returns
Type Description
CertificateAuthority.Builder

mergeLifetime(Duration value)

public CertificateAuthority.Builder mergeLifetime(Duration value)

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];

Parameter
Name Description
value Duration
Returns
Type Description
CertificateAuthority.Builder

mergeSubordinateConfig(SubordinateConfig value)

public CertificateAuthority.Builder mergeSubordinateConfig(SubordinateConfig value)

Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

.google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SubordinateConfig
Returns
Type Description
CertificateAuthority.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CertificateAuthority.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CertificateAuthority.Builder
Overrides

mergeUpdateTime(Timestamp value)

public CertificateAuthority.Builder mergeUpdateTime(Timestamp value)

Output only. The time at which this CertificateAuthority was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
CertificateAuthority.Builder

putAllLabels(Map<String,String> values)

public CertificateAuthority.Builder putAllLabels(Map<String,String> values)

Optional. Labels with user-defined metadata.

map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
CertificateAuthority.Builder

putLabels(String key, String value)

public CertificateAuthority.Builder putLabels(String key, String value)

Optional. Labels with user-defined metadata.

map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
CertificateAuthority.Builder

removeCaCertificateDescriptions(int index)

public CertificateAuthority.Builder removeCaCertificateDescriptions(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
Type Description
CertificateAuthority.Builder

removeLabels(String key)

public CertificateAuthority.Builder removeLabels(String key)

Optional. Labels with user-defined metadata.

map<string, string> labels = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
CertificateAuthority.Builder

setAccessUrls(CertificateAuthority.AccessUrls value)

public CertificateAuthority.Builder setAccessUrls(CertificateAuthority.AccessUrls value)

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];

Parameter
Name Description
value CertificateAuthority.AccessUrls
Returns
Type Description
CertificateAuthority.Builder

setAccessUrls(CertificateAuthority.AccessUrls.Builder builderForValue)

public CertificateAuthority.Builder setAccessUrls(CertificateAuthority.AccessUrls.Builder builderForValue)

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];

Parameter
Name Description
builderForValue CertificateAuthority.AccessUrls.Builder
Returns
Type Description
CertificateAuthority.Builder

setCaCertificateDescriptions(int index, CertificateDescription value)

public CertificateAuthority.Builder setCaCertificateDescriptions(int index, CertificateDescription value)

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];

Parameters
Name Description
index int
value CertificateDescription
Returns
Type Description
CertificateAuthority.Builder

setCaCertificateDescriptions(int index, CertificateDescription.Builder builderForValue)

public CertificateAuthority.Builder setCaCertificateDescriptions(int index, CertificateDescription.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue CertificateDescription.Builder
Returns
Type Description
CertificateAuthority.Builder

setConfig(CertificateConfig value)

public CertificateAuthority.Builder setConfig(CertificateConfig value)

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];

Parameter
Name Description
value CertificateConfig
Returns
Type Description
CertificateAuthority.Builder

setConfig(CertificateConfig.Builder builderForValue)

public CertificateAuthority.Builder setConfig(CertificateConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue CertificateConfig.Builder
Returns
Type Description
CertificateAuthority.Builder

setCreateTime(Timestamp value)

public CertificateAuthority.Builder setCreateTime(Timestamp value)

Output only. The time at which this CertificateAuthority was created.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
CertificateAuthority.Builder

setCreateTime(Timestamp.Builder builderForValue)

public CertificateAuthority.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time at which this CertificateAuthority was created.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CertificateAuthority.Builder

setDeleteTime(Timestamp value)

public CertificateAuthority.Builder setDeleteTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CertificateAuthority.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public CertificateAuthority.Builder setDeleteTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CertificateAuthority.Builder

setExpireTime(Timestamp value)

public CertificateAuthority.Builder setExpireTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CertificateAuthority.Builder

setExpireTime(Timestamp.Builder builderForValue)

public CertificateAuthority.Builder setExpireTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CertificateAuthority.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CertificateAuthority.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CertificateAuthority.Builder
Overrides

setGcsBucket(String value)

public CertificateAuthority.Builder setGcsBucket(String value)

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];

Parameter
Name Description
value String

The gcsBucket to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setGcsBucketBytes(ByteString value)

public CertificateAuthority.Builder setGcsBucketBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for gcsBucket to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setKeySpec(CertificateAuthority.KeyVersionSpec value)

public CertificateAuthority.Builder setKeySpec(CertificateAuthority.KeyVersionSpec value)

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];

Parameter
Name Description
value CertificateAuthority.KeyVersionSpec
Returns
Type Description
CertificateAuthority.Builder

setKeySpec(CertificateAuthority.KeyVersionSpec.Builder builderForValue)

public CertificateAuthority.Builder setKeySpec(CertificateAuthority.KeyVersionSpec.Builder builderForValue)

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];

Parameter
Name Description
builderForValue CertificateAuthority.KeyVersionSpec.Builder
Returns
Type Description
CertificateAuthority.Builder

setLifetime(Duration value)

public CertificateAuthority.Builder setLifetime(Duration value)

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];

Parameter
Name Description
value Duration
Returns
Type Description
CertificateAuthority.Builder

setLifetime(Duration.Builder builderForValue)

public CertificateAuthority.Builder setLifetime(Duration.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CertificateAuthority.Builder

setName(String value)

public CertificateAuthority.Builder setName(String value)

Output only. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CertificateAuthority.Builder setNameBytes(ByteString value)

Output only. The resource name for this CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setPemCaCertificates(int index, String value)

public CertificateAuthority.Builder setPemCaCertificates(int index, String value)

Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

repeated string pem_ca_certificates = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.
value String

The pemCaCertificates to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CertificateAuthority.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CertificateAuthority.Builder
Overrides

setState(CertificateAuthority.State value)

public CertificateAuthority.Builder setState(CertificateAuthority.State value)

Output only. The State for this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CertificateAuthority.State

The state to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setStateValue(int value)

public CertificateAuthority.Builder setStateValue(int value)

Output only. The State for this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setSubordinateConfig(SubordinateConfig value)

public CertificateAuthority.Builder setSubordinateConfig(SubordinateConfig value)

Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

.google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SubordinateConfig
Returns
Type Description
CertificateAuthority.Builder

setSubordinateConfig(SubordinateConfig.Builder builderForValue)

public CertificateAuthority.Builder setSubordinateConfig(SubordinateConfig.Builder builderForValue)

Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

.google.cloud.security.privateca.v1.SubordinateConfig subordinate_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue SubordinateConfig.Builder
Returns
Type Description
CertificateAuthority.Builder

setTier(CaPool.Tier value)

public CertificateAuthority.Builder setTier(CaPool.Tier value)

Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CaPool.Tier

The tier to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setTierValue(int value)

public CertificateAuthority.Builder setTierValue(int value)

Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for tier to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setType(CertificateAuthority.Type value)

public CertificateAuthority.Builder setType(CertificateAuthority.Type value)

Required. Immutable. The Type of this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.Type type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value CertificateAuthority.Type

The type to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setTypeValue(int value)

public CertificateAuthority.Builder setTypeValue(int value)

Required. Immutable. The Type of this CertificateAuthority.

.google.cloud.security.privateca.v1.CertificateAuthority.Type type = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
CertificateAuthority.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CertificateAuthority.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CertificateAuthority.Builder
Overrides

setUpdateTime(Timestamp value)

public CertificateAuthority.Builder setUpdateTime(Timestamp value)

Output only. The time at which this CertificateAuthority was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
CertificateAuthority.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public CertificateAuthority.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time at which this CertificateAuthority was last updated.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CertificateAuthority.Builder