Class ServerTlsPolicy
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.networksecurity.v1beta1.ServerTlsPolicy
-
- All Implemented Interfaces:
ServerTlsPolicyOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
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 typegoogle.cloud.networksecurity.v1beta1.ServerTlsPolicy
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
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
-
-
Field Summary
Fields Modifier and Type Field 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
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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(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 ServerTlsPolicy
parseFrom(ByteBuffer data)
static ServerTlsPolicy
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ServerTlsPolicy>
parser()
ServerTlsPolicy.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
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, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ALLOW_OPEN_FIELD_NUMBER
public static final int ALLOW_OPEN_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SERVER_CERTIFICATE_FIELD_NUMBER
public static final int SERVER_CERTIFICATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MTLS_POLICY_FIELD_NUMBER
public static final int MTLS_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getName
public 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];
- Specified by:
getName
in interfaceServerTlsPolicyOrBuilder
- Returns:
- The name.
-
getNameBytes
public 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];
- Specified by:
getNameBytes
in interfaceServerTlsPolicyOrBuilder
- Returns:
- The bytes for name.
-
getDescription
public String getDescription()
Free-text description of the resource.
string description = 2;
- Specified by:
getDescription
in interfaceServerTlsPolicyOrBuilder
- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
Free-text description of the resource.
string description = 2;
- Specified by:
getDescriptionBytes
in interfaceServerTlsPolicyOrBuilder
- 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 interfaceServerTlsPolicyOrBuilder
- 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 interfaceServerTlsPolicyOrBuilder
- 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 interfaceServerTlsPolicyOrBuilder
-
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 interfaceServerTlsPolicyOrBuilder
- 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 interfaceServerTlsPolicyOrBuilder
- 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 interfaceServerTlsPolicyOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:ServerTlsPolicyOrBuilder
Set of label tags associated with the resource.
map<string, string> labels = 5;
- Specified by:
getLabelsCount
in interfaceServerTlsPolicyOrBuilder
-
containsLabels
public boolean containsLabels(String key)
Set of label tags associated with the resource.
map<string, string> labels = 5;
- Specified by:
containsLabels
in interfaceServerTlsPolicyOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceServerTlsPolicyOrBuilder
-
getLabelsMap
public Map<String,String> getLabelsMap()
Set of label tags associated with the resource.
map<string, string> labels = 5;
- Specified by:
getLabelsMap
in interfaceServerTlsPolicyOrBuilder
-
getLabelsOrDefault
public String getLabelsOrDefault(String key, String defaultValue)
Set of label tags associated with the resource.
map<string, string> labels = 5;
- Specified by:
getLabelsOrDefault
in interfaceServerTlsPolicyOrBuilder
-
getLabelsOrThrow
public String getLabelsOrThrow(String key)
Set of label tags associated with the resource.
map<string, string> labels = 5;
- Specified by:
getLabelsOrThrow
in interfaceServerTlsPolicyOrBuilder
-
getAllowOpen
public 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;
- Specified by:
getAllowOpen
in interfaceServerTlsPolicyOrBuilder
- Returns:
- The allowOpen.
-
hasServerCertificate
public 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;
- Specified by:
hasServerCertificate
in interfaceServerTlsPolicyOrBuilder
- Returns:
- Whether the serverCertificate field is set.
-
getServerCertificate
public 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;
- Specified by:
getServerCertificate
in interfaceServerTlsPolicyOrBuilder
- Returns:
- The serverCertificate.
-
getServerCertificateOrBuilder
public 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;
- Specified by:
getServerCertificateOrBuilder
in interfaceServerTlsPolicyOrBuilder
-
hasMtlsPolicy
public 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;
- Specified by:
hasMtlsPolicy
in interfaceServerTlsPolicyOrBuilder
- Returns:
- Whether the mtlsPolicy field is set.
-
getMtlsPolicy
public 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;
- Specified by:
getMtlsPolicy
in interfaceServerTlsPolicyOrBuilder
- Returns:
- The mtlsPolicy.
-
getMtlsPolicyOrBuilder
public 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;
- Specified by:
getMtlsPolicyOrBuilder
in interfaceServerTlsPolicyOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ServerTlsPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServerTlsPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServerTlsPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServerTlsPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServerTlsPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServerTlsPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServerTlsPolicy parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ServerTlsPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ServerTlsPolicy parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ServerTlsPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static ServerTlsPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ServerTlsPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public ServerTlsPolicy.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ServerTlsPolicy.Builder newBuilder()
-
newBuilder
public static ServerTlsPolicy.Builder newBuilder(ServerTlsPolicy prototype)
-
toBuilder
public ServerTlsPolicy.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ServerTlsPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static ServerTlsPolicy getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<ServerTlsPolicy> parser()
-
getParserForType
public com.google.protobuf.Parser<ServerTlsPolicy> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public ServerTlsPolicy getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-