- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public final class SslCertificate extends GeneratedMessageV3 implements SslCertificateOrBuilderRepresents an SSL certificate resource. Google Compute Engine has two SSL certificate resources: * Global * Regional The global SSL certificates (sslCertificates) are used by: - Global external Application Load Balancers - Classic Application Load Balancers - Proxy Network Load Balancers (with target SSL proxies) The regional SSL certificates (regionSslCertificates) are used by: - Regional external Application Load Balancers - Regional internal Application 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 > SslCertificateImplements
SslCertificateOrBuilderStatic Fields
CERTIFICATE_FIELD_NUMBER
public static final int CERTIFICATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_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 |
|
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
KIND_FIELD_NUMBER
public static final int KIND_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 |
|
PRIVATE_KEY_FIELD_NUMBER
public static final int PRIVATE_KEY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SELF_MANAGED_FIELD_NUMBER
public static final int SELF_MANAGED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SUBJECT_ALTERNATIVE_NAMES_FIELD_NUMBER
public static final int SUBJECT_ALTERNATIVE_NAMES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static SslCertificate getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static SslCertificate.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
SslCertificate.Builder |
|
newBuilder(SslCertificate prototype)
public static SslCertificate.Builder newBuilder(SslCertificate prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
SslCertificate |
| Returns | |
|---|---|
| Type | Description |
SslCertificate.Builder |
|
parseDelimitedFrom(InputStream input)
public static SslCertificate parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SslCertificate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static SslCertificate parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SslCertificate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static SslCertificate parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SslCertificate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static SslCertificate parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SslCertificate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static SslCertificate parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SslCertificate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static SslCertificate parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SslCertificate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<SslCertificate> parser()| Returns | |
|---|---|
| Type | Description |
Parser<SslCertificate> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for certificate. |
getCreationTimestamp()
public String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
String |
The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for creationTimestamp. |
getDefaultInstanceForType()
public SslCertificate getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SslCertificate |
|
getDescription()
public String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getExpireTime()
public String getExpireTime()[Output Only] Expire time of the certificate. RFC3339
optional string expire_time = 440691181;
| Returns | |
|---|---|
| Type | Description |
String |
The expireTime. |
getExpireTimeBytes()
public ByteString getExpireTimeBytes()[Output Only] Expire time of the certificate. RFC3339
optional string expire_time = 440691181;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
long |
The id. |
getKind()
public String getKind()[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
String |
The kind. |
getKindBytes()
public ByteString getKindBytes()[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
SslCertificateManagedSslCertificate |
The managed. |
getManagedOrBuilder()
public SslCertificateManagedSslCertificateOrBuilder getManagedOrBuilder()Configuration and status of a managed SSL certificate.
optional .google.cloud.compute.v1.SslCertificateManagedSslCertificate managed = 298389407;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<SslCertificate> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<SslCertificate> |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for region. |
getSelfLink()
public String getSelfLink()[Output only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
String |
The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()[Output only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
SslCertificateSelfManagedSslCertificateOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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 | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for type. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the type field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public SslCertificate.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
SslCertificate.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SslCertificate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
SslCertificate.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public SslCertificate.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
SslCertificate.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|