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.v1.ClientTlsPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CLIENT_CERTIFICATE_FIELD_NUMBER
public static final int CLIENT_CERTIFICATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVER_VALIDATION_CA_FIELD_NUMBER
public static final int SERVER_VALIDATION_CA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SNI_FIELD_NUMBER
public static final int SNI_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 ClientTlsPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ClientTlsPolicy.Builder newBuilder()
newBuilder(ClientTlsPolicy prototype)
public static ClientTlsPolicy.Builder newBuilder(ClientTlsPolicy prototype)
public static ClientTlsPolicy parseDelimitedFrom(InputStream input)
public static ClientTlsPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ClientTlsPolicy parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ClientTlsPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ClientTlsPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ClientTlsPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ClientTlsPolicy parseFrom(CodedInputStream input)
public static ClientTlsPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ClientTlsPolicy parseFrom(InputStream input)
public static ClientTlsPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ClientTlsPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ClientTlsPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ClientTlsPolicy> parser()
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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.v1.CertificateProvider client_certificate = 7 [(.google.api.field_behavior) = OPTIONAL];
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.v1.CertificateProvider client_certificate = 7 [(.google.api.field_behavior) = OPTIONAL];
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];
getDefaultInstanceForType()
public ClientTlsPolicy getDefaultInstanceForType()
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.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. Set of label tags associated with the resource.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
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];
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];
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 |
|---|
| Name | Description |
key | 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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<ClientTlsPolicy> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
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.v1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
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.v1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];
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.v1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1.ValidationCA server_validation_ca = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.networksecurity.v1.ValidationCAOrBuilder> | |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
ByteString | The bytes for sni.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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 |
|---|
| 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];
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.v1.CertificateProvider client_certificate = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ClientTlsPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ClientTlsPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ClientTlsPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
