Class CertificateAuthority (2.48.0)

public final class CertificateAuthority extends GeneratedMessageV3 implements CertificateAuthorityOrBuilder

A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

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

Static Fields

ACCESS_URLS_FIELD_NUMBER

public static final int ACCESS_URLS_FIELD_NUMBER
Field Value
Type Description
int

CA_CERTIFICATE_DESCRIPTIONS_FIELD_NUMBER

public static final int CA_CERTIFICATE_DESCRIPTIONS_FIELD_NUMBER
Field Value
Type Description
int

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

GCS_BUCKET_FIELD_NUMBER

public static final int GCS_BUCKET_FIELD_NUMBER
Field Value
Type Description
int

KEY_SPEC_FIELD_NUMBER

public static final int KEY_SPEC_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LIFETIME_FIELD_NUMBER

public static final int LIFETIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PEM_CA_CERTIFICATES_FIELD_NUMBER

public static final int PEM_CA_CERTIFICATES_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

SUBORDINATE_CONFIG_FIELD_NUMBER

public static final int SUBORDINATE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CertificateAuthority getDefaultInstance()
Returns
Type Description
CertificateAuthority

getDescriptor()

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

newBuilder()

public static CertificateAuthority.Builder newBuilder()
Returns
Type Description
CertificateAuthority.Builder

newBuilder(CertificateAuthority prototype)

public static CertificateAuthority.Builder newBuilder(CertificateAuthority prototype)
Parameter
Name Description
prototype CertificateAuthority
Returns
Type Description
CertificateAuthority.Builder

parseDelimitedFrom(InputStream input)

public static CertificateAuthority parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CertificateAuthority parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CertificateAuthority parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CertificateAuthority parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CertificateAuthority parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CertificateAuthority parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CertificateAuthority> parser()
Returns
Type Description
Parser<CertificateAuthority>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels with user-defined metadata.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccessUrls()

public CertificateAuthority.AccessUrls getAccessUrls()

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

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

Returns
Type Description
CertificateAuthority.AccessUrls

The accessUrls.

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

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.

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.

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.

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

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.

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