public final class ServerTlsPolicy extends com.google.protobuf.GeneratedMessageV3 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.Protobuf type
google.cloud.networksecurity.v1beta1.ServerTlsPolicy| Modifier and Type | Class and Description |
|---|---|
static class |
ServerTlsPolicy.Builder
ServerTlsPolicy is a resource that specifies how a server should authenticate
incoming requests.
|
static class |
ServerTlsPolicy.MTLSPolicy
Specification of the MTLSPolicy.
|
static interface |
ServerTlsPolicy.MTLSPolicyOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ALLOW_OPEN_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
MTLS_POLICY_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SERVER_CERTIFICATE_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Set of label tags associated with the resource.
|
boolean |
equals(Object obj) |
boolean |
getAllowOpen()
Determines if server allows plaintext connections.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static ServerTlsPolicy |
getDefaultInstance() |
ServerTlsPolicy |
getDefaultInstanceForType() |
String |
getDescription()
Free-text description of the resource.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Free-text description of the resource.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Set of label tags associated with the resource.
|
Map<String,String> |
getLabelsMap()
Set of label tags associated with the resource.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Set of label tags associated with the resource.
|
String |
getLabelsOrThrow(String key)
Set of label tags associated with the resource.
|
ServerTlsPolicy.MTLSPolicy |
getMtlsPolicy()
Defines a mechanism to provision peer validation certificates for peer to
peer authentication (Mutual TLS - mTLS).
|
ServerTlsPolicy.MTLSPolicyOrBuilder |
getMtlsPolicyOrBuilder()
Defines a mechanism to provision peer validation certificates for peer to
peer authentication (Mutual TLS - mTLS).
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
com.google.protobuf.Parser<ServerTlsPolicy> |
getParserForType() |
int |
getSerializedSize() |
CertificateProvider |
getServerCertificate()
Defines a mechanism to provision server identity (public and private keys).
|
CertificateProviderOrBuilder |
getServerCertificateOrBuilder()
Defines a mechanism to provision server identity (public and private keys).
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasMtlsPolicy()
Defines a mechanism to provision peer validation certificates for peer to
peer authentication (Mutual TLS - mTLS).
|
boolean |
hasServerCertificate()
Defines a mechanism to provision server identity (public and private keys).
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static ServerTlsPolicy.Builder |
newBuilder() |
static ServerTlsPolicy.Builder |
newBuilder(ServerTlsPolicy prototype) |
ServerTlsPolicy.Builder |
newBuilderForType() |
protected ServerTlsPolicy.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ServerTlsPolicy |
parseDelimitedFrom(InputStream input) |
static ServerTlsPolicy |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServerTlsPolicy |
parseFrom(byte[] data) |
static ServerTlsPolicy |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServerTlsPolicy |
parseFrom(ByteBuffer data) |
static ServerTlsPolicy |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServerTlsPolicy |
parseFrom(com.google.protobuf.ByteString data) |
static ServerTlsPolicy |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServerTlsPolicy |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ServerTlsPolicy |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ServerTlsPolicy |
parseFrom(InputStream input) |
static ServerTlsPolicy |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ServerTlsPolicy> |
parser() |
ServerTlsPolicy.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int ALLOW_OPEN_FIELD_NUMBER
public static final int SERVER_CERTIFICATE_FIELD_NUMBER
public static final int MTLS_POLICY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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];getName in interface ServerTlsPolicyOrBuilderpublic 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];getNameBytes in interface ServerTlsPolicyOrBuilderpublic String getDescription()
Free-text description of the resource.
string description = 2;getDescription in interface ServerTlsPolicyOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Free-text description of the resource.
string description = 2;getDescriptionBytes in interface ServerTlsPolicyOrBuilderpublic boolean hasCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface ServerTlsPolicyOrBuilderpublic 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];
getCreateTime in interface ServerTlsPolicyOrBuilderpublic 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];
getCreateTimeOrBuilder in interface ServerTlsPolicyOrBuilderpublic boolean hasUpdateTime()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface ServerTlsPolicyOrBuilderpublic 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];
getUpdateTime in interface ServerTlsPolicyOrBuilderpublic 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];
getUpdateTimeOrBuilder in interface ServerTlsPolicyOrBuilderpublic int getLabelsCount()
ServerTlsPolicyOrBuilderSet of label tags associated with the resource.
map<string, string> labels = 5;getLabelsCount in interface ServerTlsPolicyOrBuilderpublic boolean containsLabels(String key)
Set of label tags associated with the resource.
map<string, string> labels = 5;containsLabels in interface ServerTlsPolicyOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface ServerTlsPolicyOrBuilderpublic Map<String,String> getLabelsMap()
Set of label tags associated with the resource.
map<string, string> labels = 5;getLabelsMap in interface ServerTlsPolicyOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
Set of label tags associated with the resource.
map<string, string> labels = 5;getLabelsOrDefault in interface ServerTlsPolicyOrBuilderpublic String getLabelsOrThrow(String key)
Set of label tags associated with the resource.
map<string, string> labels = 5;getLabelsOrThrow in interface ServerTlsPolicyOrBuilderpublic boolean getAllowOpen()
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;getAllowOpen in interface ServerTlsPolicyOrBuilderpublic boolean hasServerCertificate()
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.v1beta1.CertificateProvider server_certificate = 7;hasServerCertificate in interface ServerTlsPolicyOrBuilderpublic CertificateProvider getServerCertificate()
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.v1beta1.CertificateProvider server_certificate = 7;getServerCertificate in interface ServerTlsPolicyOrBuilderpublic CertificateProviderOrBuilder getServerCertificateOrBuilder()
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.v1beta1.CertificateProvider server_certificate = 7;getServerCertificateOrBuilder in interface ServerTlsPolicyOrBuilderpublic boolean hasMtlsPolicy()
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.v1beta1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;hasMtlsPolicy in interface ServerTlsPolicyOrBuilderpublic ServerTlsPolicy.MTLSPolicy getMtlsPolicy()
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.v1beta1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;getMtlsPolicy in interface ServerTlsPolicyOrBuilderpublic ServerTlsPolicy.MTLSPolicyOrBuilder getMtlsPolicyOrBuilder()
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.v1beta1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;getMtlsPolicyOrBuilder in interface ServerTlsPolicyOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ServerTlsPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServerTlsPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServerTlsPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServerTlsPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServerTlsPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServerTlsPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ServerTlsPolicy parseFrom(InputStream input) throws IOException
IOExceptionpublic static ServerTlsPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ServerTlsPolicy parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ServerTlsPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ServerTlsPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ServerTlsPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ServerTlsPolicy.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ServerTlsPolicy.Builder newBuilder()
public static ServerTlsPolicy.Builder newBuilder(ServerTlsPolicy prototype)
public ServerTlsPolicy.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ServerTlsPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ServerTlsPolicy getDefaultInstance()
public static com.google.protobuf.Parser<ServerTlsPolicy> parser()
public com.google.protobuf.Parser<ServerTlsPolicy> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ServerTlsPolicy getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.