Compute V1 Client - Class SslPolicy (2.4.0)

Reference documentation and code samples for the Compute V1 Client class SslPolicy.

Represents an SSL Policy resource.

Use SSL policies to control SSL features, such as versions and cipher suites, that are offered by Application Load Balancers and proxy Network Load Balancers. For more information, read SSL policies overview.

Generated from protobuf message google.cloud.compute.v1.SslPolicy

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ creation_timestamp string

Output only. [Output Only] Creation timestamp inRFC3339 text format.
↳ custom_features array

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is notCUSTOM.
↳ description string

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

Output only. [Output Only] The list of features enabled in the SSL policy.
↳ fingerprint string

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
↳ id int|string

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

Output only. [Output only] Type of the resource. Alwayscompute#sslPolicyfor SSL policies.
↳ min_tls_version string

The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one ofTLS_1_0, TLS_1_1, TLS_1_2,TLS_1_3. When set to TLS_1_3, the profile field must be set to RESTRICTED. Check the MinTlsVersion enum for the list of possible values.
↳ name string

Name of the resource. 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.
↳ profile string

Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. Check the Profile enum for the list of possible values.
↳ region string

Output only. [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.
↳ self_link string

Output only. [Output Only] Server-defined URL for the resource.
↳ warnings array<Warnings>

Output only. [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

getCreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getCustomFeatures

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is notCUSTOM.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setCustomFeatures

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is notCUSTOM.

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

getEnabledFeatures

Output only. [Output Only] The list of features enabled in the SSL policy.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEnabledFeatures

Output only. [Output Only] The list of features enabled in the SSL policy.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getFingerprint

Fingerprint of this resource. A hash of the contents stored in this object.

This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

Returns
Type Description
string

hasFingerprint

clearFingerprint

setFingerprint

Fingerprint of this resource. A hash of the contents stored in this object.

This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

Output only. [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. [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. [Output only] Type of the resource. Alwayscompute#sslPolicyfor SSL policies.

Returns
Type Description
string

hasKind

clearKind

setKind

Output only. [Output only] Type of the resource. Alwayscompute#sslPolicyfor SSL policies.

Parameter
Name Description
var string
Returns
Type Description
$this

getMinTlsVersion

The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one ofTLS_1_0, TLS_1_1, TLS_1_2,TLS_1_3. When set to TLS_1_3, the profile field must be set to RESTRICTED.

Check the MinTlsVersion enum for the list of possible values.

Returns
Type Description
string

hasMinTlsVersion

clearMinTlsVersion

setMinTlsVersion

The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one ofTLS_1_0, TLS_1_1, TLS_1_2,TLS_1_3. When set to TLS_1_3, the profile field must be set to RESTRICTED.

Check the MinTlsVersion enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Name of the resource. 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. 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

getProfile

Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.

Check the Profile enum for the list of possible values.

Returns
Type Description
string

hasProfile

clearProfile

setProfile

Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.

Check the Profile enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

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

Returns
Type Description
string

hasRegion

clearRegion

setRegion

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLink

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

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name Description
var string
Returns
Type Description
$this

getWarnings

Output only. [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setWarnings

Output only. [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

Parameter
Name Description
var array<Warnings>
Returns
Type Description
$this