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

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.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ description string

Optional. Free-text description of the resource.

↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp when the resource was created.

↳ update_time Google\Protobuf\Timestamp

Output only. The timestamp when the resource was updated.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. Set of label tags associated with the resource.

↳ sni string

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

↳ client_certificate Google\Cloud\NetworkSecurity\V1\CertificateProvider

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

↳ server_validation_ca array<Google\Cloud\NetworkSecurity\V1\ValidationCA>

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

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. Free-text description of the resource.

Returns
TypeDescription
string

setDescription

Optional. Free-text description of the resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The timestamp when the resource was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the resource was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The timestamp when the resource was updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when the resource was updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

Optional. Set of label tags associated with the resource.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. Set of label tags associated with the resource.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getSni

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

Returns
TypeDescription
string

setSni

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
Google\Cloud\NetworkSecurity\V1\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
NameDescription
var Google\Cloud\NetworkSecurity\V1\CertificateProvider
Returns
TypeDescription
$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
TypeDescription
Google\Protobuf\Internal\RepeatedField

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
NameDescription
var array<Google\Cloud\NetworkSecurity\V1\ValidationCA>
Returns
TypeDescription
$this