Class SecuritySettings (1.26.0)

public final class SecuritySettings extends GeneratedMessageV3 implements SecuritySettingsOrBuilder

The authentication and authorization settings for a BackendService.

Protobuf type google.cloud.compute.v1.SecuritySettings

Static Fields

CLIENT_TLS_POLICY_FIELD_NUMBER

public static final int CLIENT_TLS_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

SUBJECT_ALT_NAMES_FIELD_NUMBER

public static final int SUBJECT_ALT_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SecuritySettings getDefaultInstance()
Returns
TypeDescription
SecuritySettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SecuritySettings.Builder newBuilder()
Returns
TypeDescription
SecuritySettings.Builder

newBuilder(SecuritySettings prototype)

public static SecuritySettings.Builder newBuilder(SecuritySettings prototype)
Parameter
NameDescription
prototypeSecuritySettings
Returns
TypeDescription
SecuritySettings.Builder

parseDelimitedFrom(InputStream input)

public static SecuritySettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SecuritySettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecuritySettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecuritySettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SecuritySettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SecuritySettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SecuritySettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SecuritySettings> parser()
Returns
TypeDescription
Parser<SecuritySettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getClientTlsPolicy()

public String getClientTlsPolicy()

Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact.

optional string client_tls_policy = 462325226;

Returns
TypeDescription
String

The clientTlsPolicy.

getClientTlsPolicyBytes()

public ByteString getClientTlsPolicyBytes()

Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact.

optional string client_tls_policy = 462325226;

Returns
TypeDescription
ByteString

The bytes for clientTlsPolicy.

getDefaultInstanceForType()

public SecuritySettings getDefaultInstanceForType()
Returns
TypeDescription
SecuritySettings

getParserForType()

public Parser<SecuritySettings> getParserForType()
Returns
TypeDescription
Parser<SecuritySettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSubjectAltNames(int index)

public String getSubjectAltNames(int index)

Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode). Note: This field currently has no impact.

repeated string subject_alt_names = 330029535;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The subjectAltNames at the given index.

getSubjectAltNamesBytes(int index)

public ByteString getSubjectAltNamesBytes(int index)

Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode). Note: This field currently has no impact.

repeated string subject_alt_names = 330029535;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the subjectAltNames at the given index.

getSubjectAltNamesCount()

public int getSubjectAltNamesCount()

Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode). Note: This field currently has no impact.

repeated string subject_alt_names = 330029535;

Returns
TypeDescription
int

The count of subjectAltNames.

getSubjectAltNamesList()

public ProtocolStringList getSubjectAltNamesList()

Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode). Note: This field currently has no impact.

repeated string subject_alt_names = 330029535;

Returns
TypeDescription
ProtocolStringList

A list containing the subjectAltNames.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasClientTlsPolicy()

public boolean hasClientTlsPolicy()

Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact.

optional string client_tls_policy = 462325226;

Returns
TypeDescription
boolean

Whether the clientTlsPolicy field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SecuritySettings.Builder newBuilderForType()
Returns
TypeDescription
SecuritySettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecuritySettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SecuritySettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SecuritySettings.Builder toBuilder()
Returns
TypeDescription
SecuritySettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException