publicfinalclass ServerTlsPolicyextendsGeneratedMessageV3implementsServerTlsPolicyOrBuilder
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.v1.ServerTlsPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALLOW_OPEN_FIELD_NUMBER
publicstaticfinalintALLOW_OPEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
CREATE_TIME_FIELD_NUMBER
publicstaticfinalintCREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
DESCRIPTION_FIELD_NUMBER
publicstaticfinalintDESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
LABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
MTLS_POLICY_FIELD_NUMBER
publicstaticfinalintMTLS_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SERVER_CERTIFICATE_FIELD_NUMBER
publicstaticfinalintSERVER_CERTIFICATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
UPDATE_TIME_FIELD_NUMBER
publicstaticfinalintUPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticServerTlsPolicygetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticServerTlsPolicy.BuildernewBuilder()
newBuilder(ServerTlsPolicy prototype)
publicstaticServerTlsPolicy.BuildernewBuilder(ServerTlsPolicyprototype)
publicstaticServerTlsPolicyparseDelimitedFrom(InputStreaminput)
publicstaticServerTlsPolicyparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticServerTlsPolicyparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticServerTlsPolicyparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticServerTlsPolicyparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticServerTlsPolicyparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticServerTlsPolicyparseFrom(CodedInputStreaminput)
publicstaticServerTlsPolicyparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticServerTlsPolicyparseFrom(InputStreaminput)
publicstaticServerTlsPolicyparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticServerTlsPolicyparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticServerTlsPolicyparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<ServerTlsPolicy>parser()
Methods
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)
Set of label tags associated with the resource.
map<string, string> labels = 5;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAllowOpen()
publicbooleangetAllowOpen()
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;
| Returns |
| Type |
Description |
boolean |
The allowOpen.
|
getCreateTime()
publicTimestampgetCreateTime()
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()
publicTimestampOrBuildergetCreateTimeOrBuilder()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
publicServerTlsPolicygetDefaultInstanceForType()
getDescription()
publicStringgetDescription()
Free-text description of the resource.
string description = 2;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
publicByteStringgetDescriptionBytes()
Free-text description of the resource.
string description = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getLabels() (deprecated)
publicMap<String,String>getLabels()
getLabelsCount()
publicintgetLabelsCount()
Set of label tags associated with the resource.
map<string, string> labels = 5;
| Returns |
| Type |
Description |
int |
getLabelsMap()
publicMap<String,String>getLabelsMap()
Set of label tags associated with the resource.
map<string, string> labels = 5;
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)
Set of label tags associated with the resource.
map<string, string> labels = 5;
| Returns |
| Type |
Description |
String |
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)
Set of label tags associated with the resource.
map<string, string> labels = 5;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
getMtlsPolicy()
publicServerTlsPolicy.MTLSPolicygetMtlsPolicy()
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.v1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;
getMtlsPolicyOrBuilder()
publicServerTlsPolicy.MTLSPolicyOrBuildergetMtlsPolicyOrBuilder()
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.v1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;
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];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
publicByteStringgetNameBytes()
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];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
publicParser<ServerTlsPolicy>getParserForType()
Overrides
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getServerCertificate()
publicCertificateProvidergetServerCertificate()
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.v1.CertificateProvider server_certificate = 7;
getServerCertificateOrBuilder()
publicCertificateProviderOrBuildergetServerCertificateOrBuilder()
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.v1.CertificateProvider server_certificate = 7;
getUpdateTime()
publicTimestampgetUpdateTime()
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()
publicTimestampOrBuildergetUpdateTimeOrBuilder()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
publicbooleanhasCreateTime()
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.
|
hasMtlsPolicy()
publicbooleanhasMtlsPolicy()
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.v1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;
| Returns |
| Type |
Description |
boolean |
Whether the mtlsPolicy field is set.
|
hasServerCertificate()
publicbooleanhasServerCertificate()
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.v1.CertificateProvider server_certificate = 7;
| Returns |
| Type |
Description |
boolean |
Whether the serverCertificate field is set.
|
hasUpdateTime()
publicbooleanhasUpdateTime()
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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicServerTlsPolicy.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedServerTlsPolicy.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicServerTlsPolicy.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides