Package com.google.cloud.networksecurity.v1

Class TlsInspectionPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.networksecurity.v1.TlsInspectionPolicy
All Implemented Interfaces:
TlsInspectionPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TlsInspectionPolicy extends com.google.protobuf.GeneratedMessage implements TlsInspectionPolicyOrBuilder
 The TlsInspectionPolicy resource contains references to CA pools in
 Certificate Authority Service and associated metadata.
Protobuf type google.cloud.networksecurity.v1.TlsInspectionPolicy
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:

    • CA_POOL_FIELD_NUMBER

      public static final int CA_POOL_FIELD_NUMBER
      See Also:

    • TRUST_CONFIG_FIELD_NUMBER

      public static final int TRUST_CONFIG_FIELD_NUMBER
      See Also:

    • EXCLUDE_PUBLIC_CA_SET_FIELD_NUMBER

      public static final int EXCLUDE_PUBLIC_CA_SET_FIELD_NUMBER
      See Also:

    • MIN_TLS_VERSION_FIELD_NUMBER

      public static final int MIN_TLS_VERSION_FIELD_NUMBER
      See Also:

    • TLS_FEATURE_PROFILE_FIELD_NUMBER

      public static final int TLS_FEATURE_PROFILE_FIELD_NUMBER
      See Also:

    • CUSTOM_TLS_FEATURES_FIELD_NUMBER

      public static final int CUSTOM_TLS_FEATURES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • 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 resource. Name is of the form
 projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}
 tls_inspection_policy should match the
 pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface TlsInspectionPolicyOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. Name of the resource. Name is of the form
 projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy}
 tls_inspection_policy should match the
 pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface TlsInspectionPolicyOrBuilder
      Returns:
      The bytes for name.

    • getDescription

      public String getDescription()
       Optional. Free-text description of the resource.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface TlsInspectionPolicyOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Free-text description of the resource.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface TlsInspectionPolicyOrBuilder
      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 TlsInspectionPolicyOrBuilder
      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 TlsInspectionPolicyOrBuilder
      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 TlsInspectionPolicyOrBuilder

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

    • getCaPool

      public String getCaPool()
       Required. A CA pool resource used to issue interception certificates.
 The CA pool string has a relative resource path following the form
 "projects/{project}/locations/{location}/caPools/{ca_pool}".
      string ca_pool = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getCaPool in interface TlsInspectionPolicyOrBuilder
      Returns:
      The caPool.

    • getCaPoolBytes

      public com.google.protobuf.ByteString getCaPoolBytes()
       Required. A CA pool resource used to issue interception certificates.
 The CA pool string has a relative resource path following the form
 "projects/{project}/locations/{location}/caPools/{ca_pool}".
      string ca_pool = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getCaPoolBytes in interface TlsInspectionPolicyOrBuilder
      Returns:
      The bytes for caPool.

    • getTrustConfig

      public String getTrustConfig()
       Optional. A TrustConfig resource used when making a connection to the TLS
 server. This is a relative resource path following the form
 "projects/{project}/locations/{location}/trustConfigs/{trust_config}". This
 is necessary to intercept TLS connections to servers with certificates
 signed by a private CA or self-signed certificates.
 Note that Secure Web Proxy does not yet honor this field.
      string trust_config = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getTrustConfig in interface TlsInspectionPolicyOrBuilder
      Returns:
      The trustConfig.

    • getTrustConfigBytes

      public com.google.protobuf.ByteString getTrustConfigBytes()
       Optional. A TrustConfig resource used when making a connection to the TLS
 server. This is a relative resource path following the form
 "projects/{project}/locations/{location}/trustConfigs/{trust_config}". This
 is necessary to intercept TLS connections to servers with certificates
 signed by a private CA or self-signed certificates.
 Note that Secure Web Proxy does not yet honor this field.
      string trust_config = 6 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getTrustConfigBytes in interface TlsInspectionPolicyOrBuilder
      Returns:
      The bytes for trustConfig.

    • hasExcludePublicCaSet

      public boolean hasExcludePublicCaSet()
       Optional. If  FALSE (the default), use our default set of public CAs in
 addition to any CAs specified in trust_config. These public CAs are
 currently based on the Mozilla Root Program and are subject to change over
 time. If TRUE, do not accept our default set of public CAs. Only CAs
 specified in trust_config will be accepted. This defaults to FALSE (use
 public CAs in addition to trust_config) for backwards compatibility, but
 trusting public root CAs is *not recommended* unless the traffic in
 question is outbound to public web servers. When possible, prefer setting
 this to "false" and explicitly specifying trusted CAs and certificates in a
 TrustConfig. Note that Secure Web Proxy does not yet honor this field.
      optional bool exclude_public_ca_set = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExcludePublicCaSet in interface TlsInspectionPolicyOrBuilder
      Returns:
      Whether the excludePublicCaSet field is set.

    • getExcludePublicCaSet

      public boolean getExcludePublicCaSet()
       Optional. If  FALSE (the default), use our default set of public CAs in
 addition to any CAs specified in trust_config. These public CAs are
 currently based on the Mozilla Root Program and are subject to change over
 time. If TRUE, do not accept our default set of public CAs. Only CAs
 specified in trust_config will be accepted. This defaults to FALSE (use
 public CAs in addition to trust_config) for backwards compatibility, but
 trusting public root CAs is *not recommended* unless the traffic in
 question is outbound to public web servers. When possible, prefer setting
 this to "false" and explicitly specifying trusted CAs and certificates in a
 TrustConfig. Note that Secure Web Proxy does not yet honor this field.
      optional bool exclude_public_ca_set = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExcludePublicCaSet in interface TlsInspectionPolicyOrBuilder
      Returns:
      The excludePublicCaSet.

    • getMinTlsVersionValue

      public int getMinTlsVersionValue()
       Optional. Minimum TLS version that the firewall should use when negotiating
 connections with both clients and servers. If this is not set, then the
 default value is to allow the broadest set of clients and servers (TLS 1.0
 or higher). Setting this to more restrictive values may improve security,
 but may also prevent the firewall from connecting to some clients or
 servers.
 Note that Secure Web Proxy does not yet honor this field.
      .google.cloud.networksecurity.v1.TlsInspectionPolicy.TlsVersion min_tls_version = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMinTlsVersionValue in interface TlsInspectionPolicyOrBuilder
      Returns:
      The enum numeric value on the wire for minTlsVersion.

    • getMinTlsVersion

      public TlsInspectionPolicy.TlsVersion getMinTlsVersion()
       Optional. Minimum TLS version that the firewall should use when negotiating
 connections with both clients and servers. If this is not set, then the
 default value is to allow the broadest set of clients and servers (TLS 1.0
 or higher). Setting this to more restrictive values may improve security,
 but may also prevent the firewall from connecting to some clients or
 servers.
 Note that Secure Web Proxy does not yet honor this field.
      .google.cloud.networksecurity.v1.TlsInspectionPolicy.TlsVersion min_tls_version = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMinTlsVersion in interface TlsInspectionPolicyOrBuilder
      Returns:
      The minTlsVersion.

    • getTlsFeatureProfileValue

      public int getTlsFeatureProfileValue()
       Optional. The selected Profile. If this is not set, then the default value
 is to allow the broadest set of clients and servers ("PROFILE_COMPATIBLE").
 Setting this to more restrictive values may improve security, but may also
 prevent the TLS inspection proxy from connecting to some clients or
 servers. Note that Secure Web Proxy does not yet honor this field.
      .google.cloud.networksecurity.v1.TlsInspectionPolicy.Profile tls_feature_profile = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTlsFeatureProfileValue in interface TlsInspectionPolicyOrBuilder
      Returns:
      The enum numeric value on the wire for tlsFeatureProfile.

    • getTlsFeatureProfile

      public TlsInspectionPolicy.Profile getTlsFeatureProfile()
       Optional. The selected Profile. If this is not set, then the default value
 is to allow the broadest set of clients and servers ("PROFILE_COMPATIBLE").
 Setting this to more restrictive values may improve security, but may also
 prevent the TLS inspection proxy from connecting to some clients or
 servers. Note that Secure Web Proxy does not yet honor this field.
      .google.cloud.networksecurity.v1.TlsInspectionPolicy.Profile tls_feature_profile = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTlsFeatureProfile in interface TlsInspectionPolicyOrBuilder
      Returns:
      The tlsFeatureProfile.

    • getCustomTlsFeaturesList

      public com.google.protobuf.ProtocolStringList getCustomTlsFeaturesList()
       Optional. List of custom TLS cipher suites selected.
 This field is valid only if the selected tls_feature_profile is CUSTOM.
 The [compute.SslPoliciesService.ListAvailableFeatures][] method returns the
 set of features that can be specified in this list.
 Note that Secure Web Proxy does not yet honor this field.
      repeated string custom_tls_features = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomTlsFeaturesList in interface TlsInspectionPolicyOrBuilder
      Returns:
      A list containing the customTlsFeatures.

    • getCustomTlsFeaturesCount

      public int getCustomTlsFeaturesCount()
       Optional. List of custom TLS cipher suites selected.
 This field is valid only if the selected tls_feature_profile is CUSTOM.
 The [compute.SslPoliciesService.ListAvailableFeatures][] method returns the
 set of features that can be specified in this list.
 Note that Secure Web Proxy does not yet honor this field.
      repeated string custom_tls_features = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomTlsFeaturesCount in interface TlsInspectionPolicyOrBuilder
      Returns:
      The count of customTlsFeatures.

    • getCustomTlsFeatures

      public String getCustomTlsFeatures(int index)
       Optional. List of custom TLS cipher suites selected.
 This field is valid only if the selected tls_feature_profile is CUSTOM.
 The [compute.SslPoliciesService.ListAvailableFeatures][] method returns the
 set of features that can be specified in this list.
 Note that Secure Web Proxy does not yet honor this field.
      repeated string custom_tls_features = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomTlsFeatures in interface TlsInspectionPolicyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The customTlsFeatures at the given index.

    • getCustomTlsFeaturesBytes

      public com.google.protobuf.ByteString getCustomTlsFeaturesBytes(int index)
       Optional. List of custom TLS cipher suites selected.
 This field is valid only if the selected tls_feature_profile is CUSTOM.
 The [compute.SslPoliciesService.ListAvailableFeatures][] method returns the
 set of features that can be specified in this list.
 Note that Secure Web Proxy does not yet honor this field.
      repeated string custom_tls_features = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomTlsFeaturesBytes in interface TlsInspectionPolicyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the customTlsFeatures at the given index.

    • 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 TlsInspectionPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TlsInspectionPolicy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TlsInspectionPolicy.Builder newBuilder()

    • newBuilder

      public static TlsInspectionPolicy.Builder newBuilder(TlsInspectionPolicy prototype)

    • toBuilder

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

    • newBuilderForType

      protected TlsInspectionPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TlsInspectionPolicy getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<TlsInspectionPolicy> 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 TlsInspectionPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder