Class Certificate.Builder (2.51.0)

public static final class Certificate.Builder extends GeneratedMessageV3.Builder<Certificate.Builder> implements CertificateOrBuilder

A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.Certificate

Static Methods

getDescriptor()

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

Methods

addAllPemCertificateChain(Iterable<String> values)

public Certificate.Builder addAllPemCertificateChain(Iterable<String> values)

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The pemCertificateChain to add.

Returns
Type Description
Certificate.Builder

This builder for chaining.

addPemCertificateChain(String value)

public Certificate.Builder addPemCertificateChain(String value)

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The pemCertificateChain to add.

Returns
Type Description
Certificate.Builder

This builder for chaining.

addPemCertificateChainBytes(ByteString value)

public Certificate.Builder addPemCertificateChainBytes(ByteString value)

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the pemCertificateChain to add.

Returns
Type Description
Certificate.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Certificate build()
Returns
Type Description
Certificate

buildPartial()

public Certificate buildPartial()
Returns
Type Description
Certificate

clear()

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

clearCertificateConfig()

public Certificate.Builder clearCertificateConfig()
Returns
Type Description
Certificate.Builder

clearCertificateDescription()

public Certificate.Builder clearCertificateDescription()

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Certificate.Builder

clearCertificateTemplate()

public Certificate.Builder clearCertificateTemplate()

Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format projects/*/locations/*/certificateTemplates/*. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.

string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
Certificate.Builder

This builder for chaining.

clearConfig()

public Certificate.Builder clearConfig()

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Certificate.Builder

clearCreateTime()

public Certificate.Builder clearCreateTime()

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

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

Returns
Type Description
Certificate.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearIssuerCertificateAuthority()

public Certificate.Builder clearIssuerCertificateAuthority()

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

string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Certificate.Builder

This builder for chaining.

clearLabels()

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

clearLifetime()

public Certificate.Builder clearLifetime()

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Certificate.Builder

clearName()

public Certificate.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
Certificate.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPemCertificate()

public Certificate.Builder clearPemCertificate()

Output only. The pem-encoded, signed X.509 certificate.

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

Returns
Type Description
Certificate.Builder

This builder for chaining.

clearPemCertificateChain()

public Certificate.Builder clearPemCertificateChain()

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Certificate.Builder

This builder for chaining.

clearPemCsr()

public Certificate.Builder clearPemCsr()

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Certificate.Builder

This builder for chaining.

clearRevocationDetails()

public Certificate.Builder clearRevocationDetails()

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Certificate.Builder

clearSubjectMode()

public Certificate.Builder clearSubjectMode()

Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the DEFAULT subject mode will be used.

.google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Certificate.Builder

This builder for chaining.

clearUpdateTime()

public Certificate.Builder clearUpdateTime()

Output only. The time at which this Certificate was updated.

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

Returns
Type Description
Certificate.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels with user-defined metadata.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getCertificateConfigCase()

public Certificate.CertificateConfigCase getCertificateConfigCase()
Returns
Type Description
Certificate.CertificateConfigCase

getCertificateDescription()

public CertificateDescription getCertificateDescription()

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateDescription

The certificateDescription.

getCertificateDescriptionBuilder()

public CertificateDescription.Builder getCertificateDescriptionBuilder()

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateDescription.Builder

getCertificateDescriptionOrBuilder()

public CertificateDescriptionOrBuilder getCertificateDescriptionOrBuilder()

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateDescriptionOrBuilder

getCertificateTemplate()

public String getCertificateTemplate()

Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format projects/*/locations/*/certificateTemplates/*. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.

string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The certificateTemplate.

getCertificateTemplateBytes()

public ByteString getCertificateTemplateBytes()

Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format projects/*/locations/*/certificateTemplates/*. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.

string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for certificateTemplate.

getConfig()

public CertificateConfig getConfig()

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateConfig

The config.

getConfigBuilder()

public CertificateConfig.Builder getConfigBuilder()

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateConfig.Builder

getConfigOrBuilder()

public CertificateConfigOrBuilder getConfigOrBuilder()

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

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

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Certificate getDefaultInstanceForType()
Returns
Type Description
Certificate

getDescriptorForType()

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

getIssuerCertificateAuthority()

public String getIssuerCertificateAuthority()

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

string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The issuerCertificateAuthority.

getIssuerCertificateAuthorityBytes()

public ByteString getIssuerCertificateAuthorityBytes()

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

string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for issuerCertificateAuthority.

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 = 14 [(.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 = 14 [(.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 = 14 [(.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 = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getLifetime()

public Duration getLifetime()

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 5 [(.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 a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Builder

getLifetimeOrBuilder()

public DurationOrBuilder getLifetimeOrBuilder()

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 5 [(.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 Certificate in the format projects/*/locations/*/caPools/*/certificates/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getPemCertificate()

public String getPemCertificate()

Output only. The pem-encoded, signed X.509 certificate.

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

Returns
Type Description
String

The pemCertificate.

getPemCertificateBytes()

public ByteString getPemCertificateBytes()

Output only. The pem-encoded, signed X.509 certificate.

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

Returns
Type Description
ByteString

The bytes for pemCertificate.

getPemCertificateChain(int index)

public String getPemCertificateChain(int index)

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The pemCertificateChain at the given index.

getPemCertificateChainBytes(int index)

public ByteString getPemCertificateChainBytes(int index)

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.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 pemCertificateChain at the given index.

getPemCertificateChainCount()

public int getPemCertificateChainCount()

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of pemCertificateChain.

getPemCertificateChainList()

public ProtocolStringList getPemCertificateChainList()

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the pemCertificateChain.

getPemCsr()

public String getPemCsr()

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The pemCsr.

getPemCsrBytes()

public ByteString getPemCsrBytes()

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for pemCsr.

getRevocationDetails()

public Certificate.RevocationDetails getRevocationDetails()

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Certificate.RevocationDetails

The revocationDetails.

getRevocationDetailsBuilder()

public Certificate.RevocationDetails.Builder getRevocationDetailsBuilder()

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Certificate.RevocationDetails.Builder

getRevocationDetailsOrBuilder()

public Certificate.RevocationDetailsOrBuilder getRevocationDetailsOrBuilder()

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Certificate.RevocationDetailsOrBuilder

getSubjectMode()

public SubjectRequestMode getSubjectMode()

Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the DEFAULT subject mode will be used.

.google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
SubjectRequestMode

The subjectMode.

getSubjectModeValue()

public int getSubjectModeValue()

Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the DEFAULT subject mode will be used.

.google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for subjectMode.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time at which this Certificate was updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time at which this Certificate was updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which this Certificate was updated.

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

Returns
Type Description
TimestampOrBuilder

hasCertificateDescription()

public boolean hasCertificateDescription()

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the certificateDescription field is set.

hasConfig()

public boolean hasConfig()

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.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 Certificate was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasLifetime()

public boolean hasLifetime()

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the lifetime field is set.

hasPemCsr()

public boolean hasPemCsr()

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the pemCsr field is set.

hasRevocationDetails()

public boolean hasRevocationDetails()

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the revocationDetails field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time at which this Certificate was updated.

.google.protobuf.Timestamp update_time = 13 [(.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

mergeCertificateDescription(CertificateDescription value)

public Certificate.Builder mergeCertificateDescription(CertificateDescription value)

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CertificateDescription
Returns
Type Description
Certificate.Builder

mergeConfig(CertificateConfig value)

public Certificate.Builder mergeConfig(CertificateConfig value)

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value CertificateConfig
Returns
Type Description
Certificate.Builder

mergeCreateTime(Timestamp value)

public Certificate.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Certificate.Builder

mergeFrom(Certificate other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeLifetime(Duration value)

public Certificate.Builder mergeLifetime(Duration value)

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value Duration
Returns
Type Description
Certificate.Builder

mergeRevocationDetails(Certificate.RevocationDetails value)

public Certificate.Builder mergeRevocationDetails(Certificate.RevocationDetails value)

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Certificate.RevocationDetails
Returns
Type Description
Certificate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public Certificate.Builder mergeUpdateTime(Timestamp value)

Output only. The time at which this Certificate was updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Certificate.Builder

putAllLabels(Map<String,String> values)

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

Optional. Labels with user-defined metadata.

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

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

putLabels(String key, String value)

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

Optional. Labels with user-defined metadata.

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

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

removeLabels(String key)

public Certificate.Builder removeLabels(String key)

Optional. Labels with user-defined metadata.

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

Parameter
Name Description
key String
Returns
Type Description
Certificate.Builder

setCertificateDescription(CertificateDescription value)

public Certificate.Builder setCertificateDescription(CertificateDescription value)

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CertificateDescription
Returns
Type Description
Certificate.Builder

setCertificateDescription(CertificateDescription.Builder builderForValue)

public Certificate.Builder setCertificateDescription(CertificateDescription.Builder builderForValue)

Output only. A structured description of the issued X.509 certificate.

.google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue CertificateDescription.Builder
Returns
Type Description
Certificate.Builder

setCertificateTemplate(String value)

public Certificate.Builder setCertificateTemplate(String value)

Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format projects/*/locations/*/certificateTemplates/*. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.

string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The certificateTemplate to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setCertificateTemplateBytes(ByteString value)

public Certificate.Builder setCertificateTemplateBytes(ByteString value)

Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format projects/*/locations/*/certificateTemplates/*. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate.

string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for certificateTemplate to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setConfig(CertificateConfig value)

public Certificate.Builder setConfig(CertificateConfig value)

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value CertificateConfig
Returns
Type Description
Certificate.Builder

setConfig(CertificateConfig.Builder builderForValue)

public Certificate.Builder setConfig(CertificateConfig.Builder builderForValue)

Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

.google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];

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

setCreateTime(Timestamp value)

public Certificate.Builder setCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Certificate.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Certificate.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Certificate.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setIssuerCertificateAuthority(String value)

public Certificate.Builder setIssuerCertificateAuthority(String value)

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

string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The issuerCertificateAuthority to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setIssuerCertificateAuthorityBytes(ByteString value)

public Certificate.Builder setIssuerCertificateAuthorityBytes(ByteString value)

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

string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for issuerCertificateAuthority to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setLifetime(Duration value)

public Certificate.Builder setLifetime(Duration value)

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value Duration
Returns
Type Description
Certificate.Builder

setLifetime(Duration.Builder builderForValue)

public Certificate.Builder setLifetime(Duration.Builder builderForValue)

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.

.google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Certificate.Builder

setName(String value)

public Certificate.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Certificate.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setPemCertificate(String value)

public Certificate.Builder setPemCertificate(String value)

Output only. The pem-encoded, signed X.509 certificate.

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

Parameter
Name Description
value String

The pemCertificate to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setPemCertificateBytes(ByteString value)

public Certificate.Builder setPemCertificateBytes(ByteString value)

Output only. The pem-encoded, signed X.509 certificate.

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

Parameter
Name Description
value ByteString

The bytes for pemCertificate to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setPemCertificateChain(int index, String value)

public Certificate.Builder setPemCertificateChain(int index, String value)

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value String

The pemCertificateChain to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setPemCsr(String value)

public Certificate.Builder setPemCsr(String value)

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The pemCsr to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setPemCsrBytes(ByteString value)

public Certificate.Builder setPemCsrBytes(ByteString value)

Immutable. A pem-encoded X.509 certificate signing request (CSR).

string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for pemCsr to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

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

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

setRevocationDetails(Certificate.RevocationDetails value)

public Certificate.Builder setRevocationDetails(Certificate.RevocationDetails value)

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Certificate.RevocationDetails
Returns
Type Description
Certificate.Builder

setRevocationDetails(Certificate.RevocationDetails.Builder builderForValue)

public Certificate.Builder setRevocationDetails(Certificate.RevocationDetails.Builder builderForValue)

Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

.google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Certificate.RevocationDetails.Builder
Returns
Type Description
Certificate.Builder

setSubjectMode(SubjectRequestMode value)

public Certificate.Builder setSubjectMode(SubjectRequestMode value)

Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the DEFAULT subject mode will be used.

.google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value SubjectRequestMode

The subjectMode to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setSubjectModeValue(int value)

public Certificate.Builder setSubjectModeValue(int value)

Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the DEFAULT subject mode will be used.

.google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value int

The enum numeric value on the wire for subjectMode to set.

Returns
Type Description
Certificate.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public Certificate.Builder setUpdateTime(Timestamp value)

Output only. The time at which this Certificate was updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Certificate.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Certificate.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time at which this Certificate was updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Certificate.Builder