Compute V1 Client - Class SslCertificate (1.5.0)

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 `[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.
`↳ 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.

Generated from protobuf field optional string certificate = 341787031;

Returns
Type	Description
`string`

hasCertificate

clearCertificate

setCertificate

Generated from protobuf field optional string certificate = 341787031;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Generated from protobuf field optional string description = 422937596;

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

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

Generated from protobuf field optional string description = 422937596;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getExpireTime

[Output Only] Expire time of the certificate. RFC3339

Generated from protobuf field optional string expire_time = 440691181;

Returns
Type	Description
`string`

hasExpireTime

clearExpireTime

setExpireTime

[Output Only] Expire time of the certificate. RFC3339

Generated from protobuf field optional string expire_time = 440691181;

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.

Generated from protobuf field optional uint64 id = 3355;

Returns
Type	Description
`int\|string`

hasId

clearId

setId

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

Generated from protobuf field optional uint64 id = 3355;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getKind

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

Generated from protobuf field optional string kind = 3292052;

Returns
Type	Description
`string`

hasKind

clearKind

setKind

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

Generated from protobuf field optional string kind = 3292052;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getManaged

Configuration and status of a managed SSL certificate.

Generated from protobuf field optional .google.cloud.compute.v1.SslCertificateManagedSslCertificate managed = 298389407;

Returns
Type	Description
`Google\Cloud\Compute\V1\SslCertificateManagedSslCertificate\|null`

hasManaged

clearManaged

setManaged

Configuration and status of a managed SSL certificate.

Generated from protobuf field optional .google.cloud.compute.v1.SslCertificateManagedSslCertificate managed = 298389407;

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.

Generated from protobuf field optional string name = 3373707;

Returns
Type	Description
`string`

hasName

clearName

setName

Generated from protobuf field optional string name = 3373707;

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.

Generated from protobuf field optional string private_key = 361331107;

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.

Generated from protobuf field optional string private_key = 361331107;

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.

Generated from protobuf field optional string region = 138946292;

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.

Generated from protobuf field optional string region = 138946292;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfManaged

Configuration and status of a self-managed SSL certificate.

Generated from protobuf field optional .google.cloud.compute.v1.SslCertificateSelfManagedSslCertificate self_managed = 329284012;

Returns
Type	Description
`Google\Cloud\Compute\V1\SslCertificateSelfManagedSslCertificate\|null`

hasSelfManaged

clearSelfManaged

setSelfManaged

Configuration and status of a self-managed SSL certificate.

Generated from protobuf field optional .google.cloud.compute.v1.SslCertificateSelfManagedSslCertificate self_managed = 329284012;

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.

Generated from protobuf field repeated string subject_alternative_names = 528807907;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSubjectAlternativeNames

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

Generated from protobuf field repeated string subject_alternative_names = 528807907;

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.

Generated from protobuf field optional string type = 3575610;

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.

Generated from protobuf field optional string type = 3575610;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`