Network Security V1beta1 API - Class Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy (v0.4.0)

Reference documentation and code samples for the Network Security V1beta1 API class Google::Cloud::NetworkSecurity::V1beta1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_open

def allow_open() -> ::Boolean
Returns
  • (::Boolean) — 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.

#allow_open=

def allow_open=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Free-text description of the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Free-text description of the resource.
Returns
  • (::String) — Free-text description of the resource.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Set of label tags associated with the resource.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Set of label tags associated with the resource.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Set of label tags associated with the resource.

#mtls_policy

def mtls_policy() -> ::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy::MTLSPolicy
Returns
  • (::Google::Cloud::NetworkSecurity::V1beta1::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.

#mtls_policy=

def mtls_policy=(value) -> ::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy::MTLSPolicy
Parameter
  • value (::Google::Cloud::NetworkSecurity::V1beta1::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.
Returns
  • (::Google::Cloud::NetworkSecurity::V1beta1::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.

#name

def name() -> ::String
Returns
  • (::String) — Required. Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}
Returns
  • (::String) — Required. Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}

#server_certificate

def server_certificate() -> ::Google::Cloud::NetworkSecurity::V1beta1::CertificateProvider
Returns

#server_certificate=

def server_certificate=(value) -> ::Google::Cloud::NetworkSecurity::V1beta1::CertificateProvider
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns