public final class ServerTlsPolicy extends 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.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
public static final int ALLOW_OPEN_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 |
|
MTLS_POLICY_FIELD_NUMBER
public static final int MTLS_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVER_CERTIFICATE_FIELD_NUMBER
public static final int SERVER_CERTIFICATE_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 ServerTlsPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ServerTlsPolicy.Builder newBuilder()
newBuilder(ServerTlsPolicy prototype)
public static ServerTlsPolicy.Builder newBuilder(ServerTlsPolicy prototype)
public static ServerTlsPolicy parseDelimitedFrom(InputStream input)
public static ServerTlsPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ServerTlsPolicy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ServerTlsPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ServerTlsPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ServerTlsPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ServerTlsPolicy parseFrom(CodedInputStream input)
public static ServerTlsPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ServerTlsPolicy parseFrom(InputStream input)
public static ServerTlsPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ServerTlsPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ServerTlsPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ServerTlsPolicy> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Set of label tags associated with the resource.
map<string, string> labels = 5;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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;
| Returns |
| Type |
Description |
boolean |
The allowOpen.
|
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 ServerTlsPolicy getDefaultInstanceForType()
getDescription()
public String getDescription()
Free-text description of the resource.
string description = 2;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Free-text description of the resource.
string description = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Set of label tags associated with the resource.
map<string, string> labels = 5;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Set of label tags associated with the resource.
map<string, string> labels = 5;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Set of label tags associated with the resource.
map<string, string> labels = 5;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Set of label tags associated with the resource.
map<string, string> labels = 5;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
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.v1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;
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.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()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<ServerTlsPolicy> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.v1.CertificateProvider server_certificate = 7;
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.v1.CertificateProvider server_certificate = 7;
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];
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.
|
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.v1.ServerTlsPolicy.MTLSPolicy mtls_policy = 8;
| Returns |
| Type |
Description |
boolean |
Whether the mtlsPolicy field is set.
|
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.v1.CertificateProvider server_certificate = 7;
| Returns |
| Type |
Description |
boolean |
Whether the serverCertificate 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
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ServerTlsPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ServerTlsPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ServerTlsPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
