Reference documentation and code samples for the Network Security V1beta1 API class Google::Cloud::NetworkSecurity::V1beta1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#client_certificate
def client_certificate() -> ::Google::Cloud::NetworkSecurity::V1beta1::CertificateProvider
Returns
- (::Google::Cloud::NetworkSecurity::V1beta1::CertificateProvider) — Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.
#client_certificate=
def client_certificate=(value) -> ::Google::Cloud::NetworkSecurity::V1beta1::CertificateProvider
Parameter
- value (::Google::Cloud::NetworkSecurity::V1beta1::CertificateProvider) — Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.
Returns
- (::Google::Cloud::NetworkSecurity::V1beta1::CertificateProvider) — Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when the resource was created.
#description
def description() -> ::String
Returns
- (::String) — Optional. Free-text description of the resource.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Free-text description of the resource.
Returns
- (::String) — Optional. Free-text description of the resource.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the resource.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the resource.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the resource.
#name
def name() -> ::String
Returns
-
(::String) — Required. Name of the ClientTlsPolicy resource. It matches the pattern
projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. Name of the ClientTlsPolicy resource. It matches the pattern
projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}
Returns
-
(::String) — Required. Name of the ClientTlsPolicy resource. It matches the pattern
projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}
#server_validation_ca
def server_validation_ca() -> ::Array<::Google::Cloud::NetworkSecurity::V1beta1::ValidationCA>
Returns
- (::Array<::Google::Cloud::NetworkSecurity::V1beta1::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.
#server_validation_ca=
def server_validation_ca=(value) -> ::Array<::Google::Cloud::NetworkSecurity::V1beta1::ValidationCA>
Parameter
- value (::Array<::Google::Cloud::NetworkSecurity::V1beta1::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.
Returns
- (::Array<::Google::Cloud::NetworkSecurity::V1beta1::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.
#sni
def sni() -> ::String
Returns
- (::String) — Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
#sni=
def sni=(value) -> ::String
Parameter
- value (::String) — Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
Returns
- (::String) — Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp when the resource was updated.