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

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

ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target https proxy or endpoint config selector resource.

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

Namespace

Google \ Cloud \ NetworkSecurity \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`
`↳ description`	`string` 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` Set of label tags associated with the resource.
`↳ allow_open`	`bool` Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.
`↳ server_certificate`	`Google\Cloud\NetworkSecurity\V1\CertificateProvider` Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported.
`↳ mtls_policy`	`Google\Cloud\NetworkSecurity\V1\ServerTlsPolicy\MTLSPolicy` Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections.

getName

Required. Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

Returns
Type	Description
`string`

setName

Required. Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Free-text description of the resource.

Returns
Type	Description
`string`

setDescription

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

Set of label tags associated with the resource.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Set of label tags associated with the resource.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getAllowOpen

Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if allow_open and mtls_policy are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility.

Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.

Returns
Type	Description
`bool`

setAllowOpen

Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getServerCertificate

Defines a mechanism to provision server identity (public and private keys).

Cannot be combined with allow_open as a permissive mode that allows both plain text and TLS is not supported.

Returns
Type	Description
`Google\Cloud\NetworkSecurity\V1\CertificateProvider\|null`

hasServerCertificate

clearServerCertificate

setServerCertificate

Defines a mechanism to provision server identity (public and private keys).

Cannot be combined with allow_open as a permissive mode that allows both plain text and TLS is not supported.

Parameter
Name	Description
`var`	`Google\Cloud\NetworkSecurity\V1\CertificateProvider`

Returns
Type	Description
`$this`

getMtlsPolicy

Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If allow_open and mtls_policy are set, server allows both plain text and mTLS connections.

Returns
Type	Description
`Google\Cloud\NetworkSecurity\V1\ServerTlsPolicy\MTLSPolicy\|null`

hasMtlsPolicy

clearMtlsPolicy

setMtlsPolicy

Parameter
Name	Description
`var`	`Google\Cloud\NetworkSecurity\V1\ServerTlsPolicy\MTLSPolicy`

Returns
Type	Description
`$this`