Package com.google.cloud.networksecurity.v1

Class ServerTlsPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.networksecurity.v1.ServerTlsPolicy
All Implemented Interfaces:
ServerTlsPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ServerTlsPolicy extends com.google.protobuf.GeneratedMessage 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.

 ServerTlsPolicy in the form accepted by Application Load Balancers can
 be attached only to TargetHttpsProxy with an `EXTERNAL`, `EXTERNAL_MANAGED`
 or `INTERNAL_MANAGED` load balancing scheme. Traffic Director compatible
 ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with
 Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme.
Protobuf type google.cloud.networksecurity.v1.ServerTlsPolicy
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • ALLOW_OPEN_FIELD_NUMBER

      public static final int ALLOW_OPEN_FIELD_NUMBER
      See Also:

    • SERVER_CERTIFICATE_FIELD_NUMBER

      public static final int SERVER_CERTIFICATE_FIELD_NUMBER
      See Also:

    • MTLS_POLICY_FIELD_NUMBER

      public static final int MTLS_POLICY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • 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.

    • getDescription

      public String getDescription()
       Free-text description of the resource.
      string description = 2;
      Specified by:
      getDescription in interface ServerTlsPolicyOrBuilder
      Returns:
      The description.

    • 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

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: ServerTlsPolicyOrBuilder
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      getLabelsCount in interface ServerTlsPolicyOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      containsLabels in interface ServerTlsPolicyOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface ServerTlsPolicyOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      getLabelsMap in interface ServerTlsPolicyOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      getLabelsOrDefault in interface ServerTlsPolicyOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Set of label tags associated with the resource.
      map<string, string> labels = 5;
      Specified by:
      getLabelsOrThrow in interface ServerTlsPolicyOrBuilder

    • getAllowOpen

      public boolean getAllowOpen()
       This field applies only for Traffic Director policies. It is must be set to
 false for Application Load Balancer policies.

 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()
       Optional if policy is to be used with Traffic Director. For Application
 Load Balancers must be empty.

 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()
       Optional if policy is to be used with Traffic Director. For Application
 Load Balancers must be empty.

 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()
       Optional if policy is to be used with Traffic Director. For Application
 Load Balancers must be empty.

 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()
       This field is required if the policy is used with Application Load
 Balancers. This field can be empty for Traffic Director.

 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()
       This field is required if the policy is used with Application Load
 Balancers. This field can be empty for Traffic Director.

 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()
       This field is required if the policy is used with Application Load
 Balancers. This field can be empty for Traffic Director.

 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ServerTlsPolicy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ServerTlsPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static ServerTlsPolicy.Builder newBuilder()

    • newBuilder

      public static ServerTlsPolicy.Builder newBuilder(ServerTlsPolicy prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ServerTlsPolicy getDefaultInstance()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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