Compute V1 Client - Class SslPolicy (1.5.0)

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

Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 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 not CUSTOM.

↳ description string

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

↳ enabled_features array

[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] The unique identifier for the resource. This identifier is defined by the server.

↳ kind string

[Output only] Type of the resource. Always compute#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 of TLS_1_0, TLS_1_1, TLS_1_2. 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 of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. 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] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.

↳ self_link string

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

↳ warnings array<Google\Cloud\Compute\V1\Warnings>

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

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
TypeDescription
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
NameDescription
var string
Returns
TypeDescription
$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 not CUSTOM.

Generated from protobuf field repeated string custom_features = 34789707;

Returns
TypeDescription
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 not CUSTOM.

Generated from protobuf field repeated string custom_features = 34789707;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getEnabledFeatures

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

Generated from protobuf field repeated string enabled_features = 469017467;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEnabledFeatures

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

Generated from protobuf field repeated string enabled_features = 469017467;

Parameter
NameDescription
var string[]
Returns
TypeDescription
$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.

Generated from protobuf field optional string fingerprint = 234678500;

Returns
TypeDescription
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.

Generated from protobuf field optional string fingerprint = 234678500;

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int|string
Returns
TypeDescription
$this

getKind

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

Generated from protobuf field optional string kind = 3292052;

Returns
TypeDescription
string

hasKind

clearKind

setKind

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

Generated from protobuf field optional string kind = 3292052;

Parameter
NameDescription
var string
Returns
TypeDescription
$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 of TLS_1_0, TLS_1_1, TLS_1_2.

Check the MinTlsVersion enum for the list of possible values.

Generated from protobuf field optional string min_tls_version = 8155943;

Returns
TypeDescription
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 of TLS_1_0, TLS_1_1, TLS_1_2.

Check the MinTlsVersion enum for the list of possible values.

Generated from protobuf field optional string min_tls_version = 8155943;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string name = 3373707;

Returns
TypeDescription
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.

Generated from protobuf field optional string name = 3373707;

Parameter
NameDescription
var string
Returns
TypeDescription
$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 of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. 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.

Generated from protobuf field optional string profile = 227445161;

Returns
TypeDescription
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 of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. 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.

Generated from protobuf field optional string profile = 227445161;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRegion

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

Generated from protobuf field optional string region = 138946292;

Returns
TypeDescription
string

hasRegion

clearRegion

setRegion

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

Generated from protobuf field optional string region = 138946292;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Returns
TypeDescription
string

hasSelfLink

clearSelfLink

setSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWarnings

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

Generated from protobuf field repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setWarnings

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

Generated from protobuf field repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\Warnings>
Returns
TypeDescription
$this