Class TlsInspectionPolicy (0.94.0)

public final class TlsInspectionPolicy extends 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

Static Fields

CA_POOL_FIELD_NUMBER

public static final int CA_POOL_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_TLS_FEATURES_FIELD_NUMBER

public static final int CUSTOM_TLS_FEATURES_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXCLUDE_PUBLIC_CA_SET_FIELD_NUMBER

public static final int EXCLUDE_PUBLIC_CA_SET_FIELD_NUMBER
Field Value
Type Description
int

MIN_TLS_VERSION_FIELD_NUMBER

public static final int MIN_TLS_VERSION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TLS_FEATURE_PROFILE_FIELD_NUMBER

public static final int TLS_FEATURE_PROFILE_FIELD_NUMBER
Field Value
Type Description
int

TRUST_CONFIG_FIELD_NUMBER

public static final int TRUST_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TlsInspectionPolicy getDefaultInstance()
Returns
Type Description
TlsInspectionPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TlsInspectionPolicy.Builder newBuilder()
Returns
Type Description
TlsInspectionPolicy.Builder

newBuilder(TlsInspectionPolicy prototype)

public static TlsInspectionPolicy.Builder newBuilder(TlsInspectionPolicy prototype)
Parameter
Name Description
prototype TlsInspectionPolicy
Returns
Type Description
TlsInspectionPolicy.Builder

parseDelimitedFrom(InputStream input)

public static TlsInspectionPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TlsInspectionPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TlsInspectionPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TlsInspectionPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TlsInspectionPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TlsInspectionPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TlsInspectionPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TlsInspectionPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TlsInspectionPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TlsInspectionPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TlsInspectionPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TlsInspectionPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TlsInspectionPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TlsInspectionPolicy> parser()
Returns
Type Description
Parser<TlsInspectionPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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) = { ... }

Returns
Type Description
String

The caPool.

getCaPoolBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for caPool.

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCustomTlsFeatures(int index)

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];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The customTlsFeatures at the given index.

getCustomTlsFeaturesBytes(int index)

public 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];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the customTlsFeatures at the given index.

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];

Returns
Type Description
int

The count of customTlsFeatures.

getCustomTlsFeaturesList()

public 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];

Returns
Type Description
ProtocolStringList

A list containing the customTlsFeatures.

getDefaultInstanceForType()

public TlsInspectionPolicy getDefaultInstanceForType()
Returns
Type Description
TlsInspectionPolicy

getDescription()

public String getDescription()

Optional. Free-text description of the resource.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Free-text description of the resource.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

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];

Returns
Type Description
boolean

The excludePublicCaSet.

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];

Returns
Type Description
TlsInspectionPolicy.TlsVersion

The minTlsVersion.

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];

Returns
Type Description
int

The enum numeric value on the wire for minTlsVersion.

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?$).

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public 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?$).

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<TlsInspectionPolicy> getParserForType()
Returns
Type Description
Parser<TlsInspectionPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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];

Returns
Type Description
TlsInspectionPolicy.Profile

The tlsFeatureProfile.

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];

Returns
Type Description
int

The enum numeric value on the wire for tlsFeatureProfile.

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) = { ... }

Returns
Type Description
String

The trustConfig.

getTrustConfigBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for trustConfig.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
boolean

Whether the createTime field is set.

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];

Returns
Type Description
boolean

Whether the excludePublicCaSet field is set.

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];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TlsInspectionPolicy.Builder newBuilderForType()
Returns
Type Description
TlsInspectionPolicy.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected TlsInspectionPolicy.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TlsInspectionPolicy.Builder
Overrides

toBuilder()

public TlsInspectionPolicy.Builder toBuilder()
Returns
Type Description
TlsInspectionPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException