Interface CertificateAuthorityOrBuilder (2.56.0) 

public interface CertificateAuthorityOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Labels with user-defined metadata.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getAccessUrls()

public abstract CertificateAuthority.AccessUrls getAccessUrls()

Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.AccessUrls access_urls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.AccessUrls

The accessUrls.

getAccessUrlsOrBuilder()

public abstract CertificateAuthority.AccessUrlsOrBuilder getAccessUrlsOrBuilder()

Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.AccessUrls access_urls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CertificateAuthority.AccessUrlsOrBuilder

getCaCertificateDescriptions(int index)

public abstract 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.v1beta1.CertificateDescription ca_certificate_descriptions = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CertificateDescription

getCaCertificateDescriptionsCount()

public abstract 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.v1beta1.CertificateDescription ca_certificate_descriptions = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getCaCertificateDescriptionsList()

public abstract 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.v1beta1.CertificateDescription ca_certificate_descriptions = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<CertificateDescription>

getCaCertificateDescriptionsOrBuilder(int index)

public abstract 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.v1beta1.CertificateDescription ca_certificate_descriptions = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CertificateDescriptionOrBuilder

getCaCertificateDescriptionsOrBuilderList()

public abstract 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.v1beta1.CertificateDescription ca_certificate_descriptions = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.security.privateca.v1beta1.CertificateDescriptionOrBuilder>

getCertificatePolicy()

public abstract CertificateAuthority.CertificateAuthorityPolicy getCertificatePolicy()

Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy certificate_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy

The certificatePolicy.

getCertificatePolicyOrBuilder()

public abstract CertificateAuthority.CertificateAuthorityPolicyOrBuilder getCertificatePolicyOrBuilder()

Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy certificate_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicyOrBuilder

getConfig()

public abstract CertificateConfig getConfig()

Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.

.google.cloud.security.privateca.v1beta1.CertificateConfig config = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateConfig

The config.

getConfigOrBuilder()

public abstract CertificateConfigOrBuilder getConfigOrBuilder()

Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.

.google.cloud.security.privateca.v1beta1.CertificateConfig config = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateConfigOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

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

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getDeleteTime()

public abstract Timestamp getDeleteTime()

Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.

.google.protobuf.Timestamp delete_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.

.google.protobuf.Timestamp delete_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getGcsBucket()

public abstract 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 = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The gcsBucket.

getGcsBucketBytes()

public abstract 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 = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for gcsBucket.

getIssuingOptions()

public abstract CertificateAuthority.IssuingOptions getIssuingOptions()

Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.IssuingOptions issuing_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CertificateAuthority.IssuingOptions

The issuingOptions.

getIssuingOptionsOrBuilder()

public abstract CertificateAuthority.IssuingOptionsOrBuilder getIssuingOptionsOrBuilder()

Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.IssuingOptions issuing_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CertificateAuthority.IssuingOptionsOrBuilder

getKeySpec()

public abstract 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.v1beta1.CertificateAuthority.KeyVersionSpec key_spec = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateAuthority.KeyVersionSpec

The keySpec.

getKeySpecOrBuilder()

public abstract 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.v1beta1.CertificateAuthority.KeyVersionSpec key_spec = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateAuthority.KeyVersionSpecOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels with user-defined metadata.

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

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels with user-defined metadata.

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels with user-defined metadata.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Labels with user-defined metadata.

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

Parameter
Name Description
key String
Returns
Type Description
String

getLifetime()

public abstract Duration getLifetime()

Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The lifetime.

getLifetimeOrBuilder()

public abstract DurationOrBuilder getLifetimeOrBuilder()

Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getName()

public abstract String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getPemCaCertificates(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the pemCaCertificates.

getState()

public abstract CertificateAuthority.State getState()

Output only. The State for this CertificateAuthority.

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

Returns
Type Description
CertificateAuthority.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The State for this CertificateAuthority.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getSubordinateConfig()

public abstract 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.v1beta1.SubordinateConfig subordinate_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SubordinateConfig

The subordinateConfig.

getSubordinateConfigOrBuilder()

public abstract 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.v1beta1.SubordinateConfig subordinate_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SubordinateConfigOrBuilder

getTier()

public abstract CertificateAuthority.Tier getTier()

Required. Immutable. The Tier of this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.Tier tier = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CertificateAuthority.Tier

The tier.

getTierValue()

public abstract int getTierValue()

Required. Immutable. The Tier of this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.Tier tier = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for tier.

getType()

public abstract CertificateAuthority.Type getType()

Required. Immutable. The Type of this CertificateAuthority.

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

Returns
Type Description
CertificateAuthority.Type

The type.

getTypeValue()

public abstract int getTypeValue()

Required. Immutable. The Type of this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.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 abstract Timestamp getUpdateTime()

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

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

hasAccessUrls()

public abstract boolean hasAccessUrls()

Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.AccessUrls access_urls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the accessUrls field is set.

hasCertificatePolicy()

public abstract boolean hasCertificatePolicy()

Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy certificate_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the certificatePolicy field is set.

hasConfig()

public abstract boolean hasConfig()

Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.

.google.cloud.security.privateca.v1beta1.CertificateConfig config = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the config field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

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

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public abstract boolean hasDeleteTime()

Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.

.google.protobuf.Timestamp delete_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasIssuingOptions()

public abstract boolean hasIssuingOptions()

Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.IssuingOptions issuing_options = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the issuingOptions field is set.

hasKeySpec()

public abstract 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.v1beta1.CertificateAuthority.KeyVersionSpec key_spec = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the keySpec field is set.

hasLifetime()

public abstract boolean hasLifetime()

Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the lifetime field is set.

hasSubordinateConfig()

public abstract 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.v1beta1.SubordinateConfig subordinate_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the subordinateConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

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

Returns
Type Description
boolean

Whether the updateTime field is set.