Reference documentation and code samples for the Compute V1 Client class SslCertificate.
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.
Generated from protobuf message google.cloud.compute.v1.SslCertificate
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ certificate |
string
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. |
↳ creation_timestamp |
string
[Output Only] Creation timestamp in RFC3339 text format. |
↳ description |
string
An optional description of this resource. Provide this property when you create the resource. |
↳ expire_time |
string
[Output Only] Expire time of the certificate. RFC3339 |
↳ id |
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
↳ kind |
string
[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. |
↳ managed |
Google\Cloud\Compute\V1\SslCertificateManagedSslCertificate
Configuration and status of a managed SSL certificate. |
↳ name |
string
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 |
↳ private_key |
string
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. |
↳ region |
string
[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. |
↳ self_link |
string
[Output only] Server-defined URL for the resource. |
↳ self_managed |
Google\Cloud\Compute\V1\SslCertificateSelfManagedSslCertificate
Configuration and status of a self-managed SSL certificate. |
↳ subject_alternative_names |
array
[Output Only] Domains associated with the certificate via Subject Alternative Name. |
↳ type |
string
(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. |
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.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCertificate
clearCertificate
setCertificate
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string | |
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
An optional description of this resource. Provide this property when you create the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpireTime
[Output Only] Expire time of the certificate. RFC3339
| Returns | |
|---|---|
| Type | Description |
string | |
hasExpireTime
clearExpireTime
setExpireTime
[Output Only] Expire time of the certificate. RFC3339
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getManaged
Configuration and status of a managed SSL certificate.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\SslCertificateManagedSslCertificate|null | |
hasManaged
clearManaged
setManaged
Configuration and status of a managed SSL certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\SslCertificateManagedSslCertificate
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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]([-a-z0-9]*[a-z0-9])? 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.
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
clearName
setName
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]([-a-z0-9]*[a-z0-9])? 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
string | |
hasPrivateKey
clearPrivateKey
setPrivateKey
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegion
[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
| Returns | |
|---|---|
| Type | Description |
string | |
hasRegion
clearRegion
setRegion
[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfLink
[Output only] Server-defined URL for the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
hasSelfLink
clearSelfLink
setSelfLink
[Output only] Server-defined URL for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelfManaged
Configuration and status of a self-managed SSL certificate.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\SslCertificateSelfManagedSslCertificate|null | |
hasSelfManaged
clearSelfManaged
setSelfManaged
Configuration and status of a self-managed SSL certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\SslCertificateSelfManagedSslCertificate
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubjectAlternativeNames
[Output Only] Domains associated with the certificate via Subject Alternative Name.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSubjectAlternativeNames
[Output Only] Domains associated with the certificate via Subject Alternative Name.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
string | |
hasType
clearType
setType
(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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |