Class Certificate (0.58.0)

public final class Certificate extends GeneratedMessageV3 implements CertificateOrBuilder

Defines TLS certificate.

Protobuf type google.cloud.certificatemanager.v1.Certificate

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MANAGED_FIELD_NUMBER

public static final int MANAGED_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PEM_CERTIFICATE_FIELD_NUMBER

public static final int PEM_CERTIFICATE_FIELD_NUMBER
Field Value
Type Description
int

SAN_DNSNAMES_FIELD_NUMBER

public static final int SAN_DNSNAMES_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

SELF_MANAGED_FIELD_NUMBER

public static final int SELF_MANAGED_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 Certificate getDefaultInstance()
Returns
Type Description
Certificate

getDescriptor()

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

newBuilder()

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

newBuilder(Certificate prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Set of labels associated with a Certificate.

map<string, string> labels = 4;

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation timestamp of a Certificate.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp of a Certificate.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Certificate getDefaultInstanceForType()
Returns
Type Description
Certificate

getDescription()

public String getDescription()

One or more paragraphs of text description of a certificate.

string description = 8;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

One or more paragraphs of text description of a certificate.

string description = 8;

Returns
Type Description
ByteString

The bytes for description.

getExpireTime()

public Timestamp getExpireTime()

Output only. The expiry timestamp of a Certificate.

.google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Output only. The expiry timestamp of a Certificate.

.google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Set of labels associated with a Certificate.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Set of labels associated with a Certificate.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Set of labels associated with a Certificate.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Set of labels associated with a Certificate.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getManaged()

public Certificate.ManagedCertificate getManaged()

If set, contains configuration and state of a managed certificate.

.google.cloud.certificatemanager.v1.Certificate.ManagedCertificate managed = 11;

Returns
Type Description
Certificate.ManagedCertificate

The managed.

getManagedOrBuilder()

public Certificate.ManagedCertificateOrBuilder getManagedOrBuilder()

If set, contains configuration and state of a managed certificate.

.google.cloud.certificatemanager.v1.Certificate.ManagedCertificate managed = 11;

Returns
Type Description
Certificate.ManagedCertificateOrBuilder

getName()

public String getName()

A user-defined name of the certificate. Certificate names must be unique globally and match pattern projects/*/locations/*/certificates/*.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

A user-defined name of the certificate. Certificate names must be unique globally and match pattern projects/*/locations/*/certificates/*.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Certificate> getParserForType()
Returns
Type Description
Parser<Certificate>
Overrides

getPemCertificate()

public String getPemCertificate()

Output only. The PEM-encoded certificate chain.

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 certificate chain.

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

Returns
Type Description
ByteString

The bytes for pemCertificate.

getSanDnsnames(int index)

public String getSanDnsnames(int index)

Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6). Managed certificates that haven't been provisioned yet have this field populated with a value of the managed.domains field.

repeated string san_dnsnames = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The sanDnsnames at the given index.

getSanDnsnamesBytes(int index)

public ByteString getSanDnsnamesBytes(int index)

Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6). Managed certificates that haven't been provisioned yet have this field populated with a value of the managed.domains field.

repeated string san_dnsnames = 6 [(.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 sanDnsnames at the given index.

getSanDnsnamesCount()

public int getSanDnsnamesCount()

Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6). Managed certificates that haven't been provisioned yet have this field populated with a value of the managed.domains field.

repeated string san_dnsnames = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of sanDnsnames.

getSanDnsnamesList()

public ProtocolStringList getSanDnsnamesList()

Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6). Managed certificates that haven't been provisioned yet have this field populated with a value of the managed.domains field.

repeated string san_dnsnames = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the sanDnsnames.

getScope()

public Certificate.Scope getScope()

Immutable. The scope of the certificate.

.google.cloud.certificatemanager.v1.Certificate.Scope scope = 12 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Certificate.Scope

The scope.

getScopeValue()

public int getScopeValue()

Immutable. The scope of the certificate.

.google.cloud.certificatemanager.v1.Certificate.Scope scope = 12 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for scope.

getSelfManaged()

public Certificate.SelfManagedCertificate getSelfManaged()

If set, defines data of a self-managed certificate.

.google.cloud.certificatemanager.v1.Certificate.SelfManagedCertificate self_managed = 5;

Returns
Type Description
Certificate.SelfManagedCertificate

The selfManaged.

getSelfManagedOrBuilder()

public Certificate.SelfManagedCertificateOrBuilder getSelfManagedOrBuilder()

If set, defines data of a self-managed certificate.

.google.cloud.certificatemanager.v1.Certificate.SelfManagedCertificate self_managed = 5;

Returns
Type Description
Certificate.SelfManagedCertificateOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTypeCase()

public Certificate.TypeCase getTypeCase()
Returns
Type Description
Certificate.TypeCase

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update timestamp of a Certificate.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update timestamp of a Certificate.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation timestamp of a Certificate.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasExpireTime()

public boolean hasExpireTime()

Output only. The expiry timestamp of a Certificate.

.google.protobuf.Timestamp expire_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expireTime field is set.

hasManaged()

public boolean hasManaged()

If set, contains configuration and state of a managed certificate.

.google.cloud.certificatemanager.v1.Certificate.ManagedCertificate managed = 11;

Returns
Type Description
boolean

Whether the managed field is set.

hasSelfManaged()

public boolean hasSelfManaged()

If set, defines data of a self-managed certificate.

.google.cloud.certificatemanager.v1.Certificate.SelfManagedCertificate self_managed = 5;

Returns
Type Description
boolean

Whether the selfManaged field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last update timestamp of a Certificate.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Certificate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Certificate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException