Google Cloud Network Security V1 Client - Class ClientTlsPolicy (1.2.3)

Reference documentation and code samples for the Google Cloud Network Security V1 Client class ClientTlsPolicy.

ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

Generated from protobuf message google.cloud.networksecurity.v1.ClientTlsPolicy

Namespace

Google \ Cloud \ NetworkSecurity \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

getName

Required. Name of the ClientTlsPolicy resource. It matches the pattern projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}

Returns
Type Description
string

setName

Required. Name of the ClientTlsPolicy resource. It matches the pattern projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. Free-text description of the resource.

Returns
Type Description
string

setDescription

Optional. Free-text description of the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when the resource was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the resource was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The timestamp when the resource was updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when the resource was updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

Optional. Set of label tags associated with the resource.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Set of label tags associated with the resource.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getSni

Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".

Returns
Type Description
string

setSni

Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".

Parameter
Name Description
var string
Returns
Type Description
$this

getClientCertificate

Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.

Returns
Type Description
CertificateProvider|null

hasClientCertificate

clearClientCertificate

setClientCertificate

Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.

Parameter
Name Description
var CertificateProvider
Returns
Type Description
$this

getServerValidationCa

Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.

Returns
Type Description
Google\Protobuf\RepeatedField<ValidationCA>

setServerValidationCa

Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.

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