Class SslCertificate (1.6.0-beta) 

public final class SslCertificate extends GeneratedMessageV3 implements SslCertificateOrBuilder

Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * Global * Regional The sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers The regionSslCertificates are used by internal HTTPS load balancers. Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.

Protobuf type google.cloud.compute.v1.SslCertificate

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SslCertificate

Fields

CERTIFICATE_FIELD_NUMBER

public static final int CERTIFICATE_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

MANAGED_FIELD_NUMBER

public static final int MANAGED_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PRIVATE_KEY_FIELD_NUMBER

public static final int PRIVATE_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

SELF_MANAGED_FIELD_NUMBER

public static final int SELF_MANAGED_FIELD_NUMBER
Field Value
TypeDescription
int

SUBJECT_ALTERNATIVE_NAMES_FIELD_NUMBER

public static final int SUBJECT_ALTERNATIVE_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCertificate()

public String getCertificate()

A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

optional string certificate = 341787031;

Returns
TypeDescription
String

The certificate.

getCertificateBytes()

public ByteString getCertificateBytes()

A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

optional string certificate = 341787031;

Returns
TypeDescription
ByteString

The bytes for certificate.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstance()

public static SslCertificate getDefaultInstance()
Returns
TypeDescription
SslCertificate

getDefaultInstanceForType()

public SslCertificate getDefaultInstanceForType()
Returns
TypeDescription
SslCertificate

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getExpireTime()

public String getExpireTime()

[Output Only] Expire time of the certificate. RFC3339

optional string expire_time = 440691181;

Returns
TypeDescription
String

The expireTime.

getExpireTimeBytes()

public ByteString getExpireTimeBytes()

[Output Only] Expire time of the certificate. RFC3339

optional string expire_time = 440691181;

Returns
TypeDescription
ByteString

The bytes for expireTime.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getManaged()

public SslCertificateManagedSslCertificate getManaged()

Configuration and status of a managed SSL certificate.

optional .google.cloud.compute.v1.SslCertificateManagedSslCertificate managed = 298389407;

Returns
TypeDescription
SslCertificateManagedSslCertificate

The managed.

getManagedOrBuilder()

public SslCertificateManagedSslCertificateOrBuilder getManagedOrBuilder()

Configuration and status of a managed SSL certificate.

optional .google.cloud.compute.v1.SslCertificateManagedSslCertificate managed = 298389407;

Returns
TypeDescription
SslCertificateManagedSslCertificateOrBuilder

getName()

public String getName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<SslCertificate> getParserForType()
Returns
TypeDescription
Parser<SslCertificate>
Overrides

getPrivateKey()

public String getPrivateKey()

A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

optional string private_key = 361331107;

Returns
TypeDescription
String

The privateKey.

getPrivateKeyBytes()

public ByteString getPrivateKeyBytes()

A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

optional string private_key = 361331107;

Returns
TypeDescription
ByteString

The bytes for privateKey.

getRegion()

public String getRegion()

[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

optional string region = 138946292;

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

optional string region = 138946292;

Returns
TypeDescription
ByteString

The bytes for region.

getSelfLink()

public String getSelfLink()

[Output only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSelfManaged()

public SslCertificateSelfManagedSslCertificate getSelfManaged()

Configuration and status of a self-managed SSL certificate.

optional .google.cloud.compute.v1.SslCertificateSelfManagedSslCertificate self_managed = 329284012;

Returns
TypeDescription
SslCertificateSelfManagedSslCertificate

The selfManaged.

getSelfManagedOrBuilder()

public SslCertificateSelfManagedSslCertificateOrBuilder getSelfManagedOrBuilder()

Configuration and status of a self-managed SSL certificate.

optional .google.cloud.compute.v1.SslCertificateSelfManagedSslCertificate self_managed = 329284012;

Returns
TypeDescription
SslCertificateSelfManagedSslCertificateOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSubjectAlternativeNames(int index)

public String getSubjectAlternativeNames(int index)

[Output Only] Domains associated with the certificate via Subject Alternative Name.

repeated string subject_alternative_names = 528807907;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The subjectAlternativeNames at the given index.

getSubjectAlternativeNamesBytes(int index)

public ByteString getSubjectAlternativeNamesBytes(int index)

[Output Only] Domains associated with the certificate via Subject Alternative Name.

repeated string subject_alternative_names = 528807907;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the subjectAlternativeNames at the given index.

getSubjectAlternativeNamesCount()

public int getSubjectAlternativeNamesCount()

[Output Only] Domains associated with the certificate via Subject Alternative Name.

repeated string subject_alternative_names = 528807907;

Returns
TypeDescription
int

The count of subjectAlternativeNames.

getSubjectAlternativeNamesList()

public ProtocolStringList getSubjectAlternativeNamesList()

[Output Only] Domains associated with the certificate via Subject Alternative Name.

repeated string subject_alternative_names = 528807907;

Returns
TypeDescription
ProtocolStringList

A list containing the subjectAlternativeNames.

getType()

public String getType()

(Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

(Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
ByteString

The bytes for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCertificate()

public boolean hasCertificate()

A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

optional string certificate = 341787031;

Returns
TypeDescription
boolean

Whether the certificate field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasExpireTime()

public boolean hasExpireTime()

[Output Only] Expire time of the certificate. RFC3339

optional string expire_time = 440691181;

Returns
TypeDescription
boolean

Whether the expireTime field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasManaged()

public boolean hasManaged()

Configuration and status of a managed SSL certificate.

optional .google.cloud.compute.v1.SslCertificateManagedSslCertificate managed = 298389407;

Returns
TypeDescription
boolean

Whether the managed field is set.

hasName()

public boolean hasName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hasPrivateKey()

public boolean hasPrivateKey()

A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.

optional string private_key = 361331107;

Returns
TypeDescription
boolean

Whether the privateKey field is set.

hasRegion()

public boolean hasRegion()

[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.

optional string region = 138946292;

Returns
TypeDescription
boolean

Whether the region field is set.

hasSelfLink()

public boolean hasSelfLink()

[Output only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasSelfManaged()

public boolean hasSelfManaged()

Configuration and status of a self-managed SSL certificate.

optional .google.cloud.compute.v1.SslCertificateSelfManagedSslCertificate self_managed = 329284012;

Returns
TypeDescription
boolean

Whether the selfManaged field is set.

hasType()

public boolean hasType()

(Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
boolean

Whether the type field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static SslCertificate.Builder newBuilder()
Returns
TypeDescription
SslCertificate.Builder

newBuilder(SslCertificate prototype)

public static SslCertificate.Builder newBuilder(SslCertificate prototype)
Parameter
NameDescription
prototypeSslCertificate
Returns
TypeDescription
SslCertificate.Builder

newBuilderForType()

public SslCertificate.Builder newBuilderForType()
Returns
TypeDescription
SslCertificate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SslCertificate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SslCertificate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static SslCertificate parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SslCertificate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SslCertificate parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SslCertificate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SslCertificate parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SslCertificate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SslCertificate parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SslCertificate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SslCertificate parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SslCertificate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SslCertificate parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SslCertificate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SslCertificate
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SslCertificate> parser()
Returns
TypeDescription
Parser<SslCertificate>

toBuilder()

public SslCertificate.Builder toBuilder()
Returns
TypeDescription
SslCertificate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException