Compute V1 Client - Class TargetSslProxy (1.5.0)

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

Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies.

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

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ certificate_map
string

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

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

↳ 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#targetSslProxy for target SSL proxies.

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

↳ proxy_header
string

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Check the ProxyHeader enum for the list of possible values.

↳ self_link
string

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

↳ service
string

URL to the BackendService resource.

↳ ssl_certificates
array

URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

↳ ssl_policy
string

URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.

getCertificateMap

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

Generated from protobuf field optional string certificate_map = 156463796;

Returns
Type
Description
string

hasCertificateMap

clearCertificateMap

setCertificateMap

URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.

Generated from protobuf field optional string certificate_map = 156463796;

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

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#targetSslProxy for target SSL proxies.

Generated from protobuf field optional string kind = 3292052;

Returns
Type
Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.

Generated from protobuf field optional string kind = 3292052;

Parameter
Name
Description
var
string
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

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;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getProxyHeader

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Check the ProxyHeader enum for the list of possible values.

Generated from protobuf field optional string proxy_header = 160374142;

Returns
Type
Description
string

hasProxyHeader

clearProxyHeader

setProxyHeader

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Check the ProxyHeader enum for the list of possible values.

Generated from protobuf field optional string proxy_header = 160374142;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

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

Generated from protobuf field optional string self_link = 456214797;

Returns
Type
Description
string

[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

getService

URL to the BackendService resource.

Generated from protobuf field optional string service = 373540533;

Returns
Type
Description
string

hasService

clearService

setService

URL to the BackendService resource.

Generated from protobuf field optional string service = 373540533;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSslCertificates

URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

Generated from protobuf field repeated string ssl_certificates = 366006543;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setSslCertificates

URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.

Generated from protobuf field repeated string ssl_certificates = 366006543;

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

getSslPolicy

URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.

Generated from protobuf field optional string ssl_policy = 295190213;

Returns
Type
Description
string

hasSslPolicy

clearSslPolicy

setSslPolicy

URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.

Generated from protobuf field optional string ssl_policy = 295190213;

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: