Class ClientTlsPolicy (0.15.0)

public final class ClientTlsPolicy extends GeneratedMessageV3 implements ClientTlsPolicyOrBuilder

ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

Protobuf type google.cloud.networksecurity.v1beta1.ClientTlsPolicy

Static Fields

CLIENT_CERTIFICATE_FIELD_NUMBER

public static final int CLIENT_CERTIFICATE_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SERVER_VALIDATION_CA_FIELD_NUMBER

public static final int SERVER_VALIDATION_CA_FIELD_NUMBER
Field Value
TypeDescription
int

SNI_FIELD_NUMBER

public static final int SNI_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ClientTlsPolicy getDefaultInstance()
Returns
TypeDescription
ClientTlsPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ClientTlsPolicy.Builder newBuilder()
Returns
TypeDescription
ClientTlsPolicy.Builder

newBuilder(ClientTlsPolicy prototype)

public static ClientTlsPolicy.Builder newBuilder(ClientTlsPolicy prototype)
Parameter
NameDescription
prototypeClientTlsPolicy
Returns
TypeDescription
ClientTlsPolicy.Builder

parseDelimitedFrom(InputStream input)

public static ClientTlsPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ClientTlsPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ClientTlsPolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ClientTlsPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ClientTlsPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ClientTlsPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ClientTlsPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ClientTlsPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ClientTlsPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ClientTlsPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ClientTlsPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ClientTlsPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ClientTlsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ClientTlsPolicy> parser()
Returns
TypeDescription
Parser<ClientTlsPolicy>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Set of label tags associated with the resource.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getClientCertificate()

public CertificateProvider getClientCertificate()

Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.

.google.cloud.networksecurity.v1beta1.CertificateProvider client_certificate = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CertificateProvider

The clientCertificate.

getClientCertificateOrBuilder()

public CertificateProviderOrBuilder getClientCertificateOrBuilder()

Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.

.google.cloud.networksecurity.v1beta1.CertificateProvider client_certificate = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CertificateProviderOrBuilder

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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ClientTlsPolicy getDefaultInstanceForType()
Returns
TypeDescription
ClientTlsPolicy

getDescription()

public String getDescription()

Optional. Free-text description of the resource.

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

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Free-text description of the resource.

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

Returns
TypeDescription
ByteString

The bytes for description.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Set of label tags associated with the resource.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Set of label tags associated with the resource.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Set of label tags associated with the resource.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Set of label tags associated with the resource.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Required. Name of the ClientTlsPolicy resource. It matches the pattern projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Name of the ClientTlsPolicy resource. It matches the pattern projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ClientTlsPolicy> getParserForType()
Returns
TypeDescription
Parser<ClientTlsPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServerValidationCa(int index)

public ValidationCA getServerValidationCa(int index)

Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.

repeated .google.cloud.networksecurity.v1beta1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
ValidationCA

getServerValidationCaCount()

public int getServerValidationCaCount()

Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.

repeated .google.cloud.networksecurity.v1beta1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getServerValidationCaList()

public List<ValidationCA> getServerValidationCaList()

Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.

repeated .google.cloud.networksecurity.v1beta1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<ValidationCA>

getServerValidationCaOrBuilder(int index)

public ValidationCAOrBuilder getServerValidationCaOrBuilder(int index)

Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.

repeated .google.cloud.networksecurity.v1beta1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
ValidationCAOrBuilder

getServerValidationCaOrBuilderList()

public List<? extends ValidationCAOrBuilder> getServerValidationCaOrBuilderList()

Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.

repeated .google.cloud.networksecurity.v1beta1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.networksecurity.v1beta1.ValidationCAOrBuilder>

getSni()

public String getSni()

Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".

string sni = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The sni.

getSniBytes()

public ByteString getSniBytes()

Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".

string sni = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for sni.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
TimestampOrBuilder

hasClientCertificate()

public boolean hasClientCertificate()

Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.

.google.cloud.networksecurity.v1beta1.CertificateProvider client_certificate = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the clientCertificate field is set.

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
TypeDescription
boolean

Whether the createTime 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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ClientTlsPolicy.Builder newBuilderForType()
Returns
TypeDescription
ClientTlsPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ClientTlsPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ClientTlsPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ClientTlsPolicy.Builder toBuilder()
Returns
TypeDescription
ClientTlsPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException