Package com.google.cloud.networksecurity.v1

Class ServerTlsPolicy

  • All Implemented Interfaces:
    ServerTlsPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ServerTlsPolicy
extends com.google.protobuf.GeneratedMessageV3
implements ServerTlsPolicyOrBuilder
     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.
    Protobuf type google.cloud.networksecurity.v1.ServerTlsPolicy
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Required. Name of the ServerTlsPolicy resource. It matches the pattern
 `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface ServerTlsPolicyOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. Name of the ServerTlsPolicy resource. It matches the pattern
 `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface ServerTlsPolicyOrBuilder
        Returns:
        The bytes for name.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Free-text description of the resource.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface ServerTlsPolicyOrBuilder
        Returns:
        The bytes for description.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The timestamp when the resource was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ServerTlsPolicyOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The timestamp when the resource was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ServerTlsPolicyOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The timestamp when the resource was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ServerTlsPolicyOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The timestamp when the resource was updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface ServerTlsPolicyOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The timestamp when the resource was updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ServerTlsPolicyOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The timestamp when the resource was updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ServerTlsPolicyOrBuilder

      • getAllowOpen

        public boolean 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.
        bool allow_open = 6;
        Specified by:
        getAllowOpen in interface ServerTlsPolicyOrBuilder
        Returns:
        The allowOpen.

      • hasServerCertificate

        public boolean hasServerCertificate()
        
 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.
        .google.cloud.networksecurity.v1.CertificateProvider server_certificate = 7;
        Specified by:
        hasServerCertificate in interface ServerTlsPolicyOrBuilder
        Returns:
        Whether the serverCertificate field is set.

      • getServerCertificate

        public CertificateProvider 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.
        .google.cloud.networksecurity.v1.CertificateProvider server_certificate = 7;
        Specified by:
        getServerCertificate in interface ServerTlsPolicyOrBuilder
        Returns:
        The serverCertificate.

      • getServerCertificateOrBuilder

        public CertificateProviderOrBuilder getServerCertificateOrBuilder()
        
 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.
        .google.cloud.networksecurity.v1.CertificateProvider server_certificate = 7;
        Specified by:
        getServerCertificateOrBuilder in interface ServerTlsPolicyOrBuilder

      • hasMtlsPolicy

        public boolean hasMtlsPolicy()
        
 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.
        .google.cloud.networksecurity.v1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;
        Specified by:
        hasMtlsPolicy in interface ServerTlsPolicyOrBuilder
        Returns:
        Whether the mtlsPolicy field is set.

      • getMtlsPolicy

        public ServerTlsPolicy.MTLSPolicy 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.
        .google.cloud.networksecurity.v1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;
        Specified by:
        getMtlsPolicy in interface ServerTlsPolicyOrBuilder
        Returns:
        The mtlsPolicy.

      • getMtlsPolicyOrBuilder

        public ServerTlsPolicy.MTLSPolicyOrBuilder getMtlsPolicyOrBuilder()
        
 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.
        .google.cloud.networksecurity.v1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;
        Specified by:
        getMtlsPolicyOrBuilder in interface ServerTlsPolicyOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ServerTlsPolicy parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ServerTlsPolicy parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ServerTlsPolicy parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ServerTlsPolicy parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ServerTlsPolicy parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ServerTlsPolicy parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ServerTlsPolicy parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ServerTlsPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ServerTlsPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ServerTlsPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<ServerTlsPolicy> parser()

      • getParserForType

        public com.google.protobuf.Parser<ServerTlsPolicy> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ServerTlsPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder