Class SecuritySettings (1.52.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

AWS_V4_AUTHENTICATION_FIELD_NUMBER

public static final int AWS_V4_AUTHENTICATION_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_TLS_POLICY_FIELD_NUMBER

public static final int CLIENT_TLS_POLICY_FIELD_NUMBER
Field Value
Type Description
int

SUBJECT_ALT_NAMES_FIELD_NUMBER

public static final int SUBJECT_ALT_NAMES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SecuritySettings getDefaultInstance()
Returns
Type Description
SecuritySettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SecuritySettings.Builder newBuilder()
Returns
Type Description
SecuritySettings.Builder

newBuilder(SecuritySettings prototype)

public static SecuritySettings.Builder newBuilder(SecuritySettings prototype)
Parameter
Name Description
prototype SecuritySettings
Returns
Type Description
SecuritySettings.Builder

parseDelimitedFrom(InputStream input)

public static SecuritySettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SecuritySettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecuritySettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecuritySettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SecuritySettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SecuritySettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecuritySettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecuritySettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SecuritySettings> parser()
Returns
Type Description
Parser<SecuritySettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAwsV4Authentication()

public AWSV4Signature getAwsV4Authentication()

The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.

optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;

Returns
Type Description
AWSV4Signature

The awsV4Authentication.

getAwsV4AuthenticationOrBuilder()

public AWSV4SignatureOrBuilder getAwsV4AuthenticationOrBuilder()

The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.

optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;

Returns
Type Description
AWSV4SignatureOrBuilder

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.

optional string client_tls_policy = 462325226;

Returns
Type Description
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.

optional string client_tls_policy = 462325226;

Returns
Type Description
ByteString

The bytes for clientTlsPolicy.

getDefaultInstanceForType()

public SecuritySettings getDefaultInstanceForType()
Returns
Type Description
SecuritySettings

getParserForType()

public Parser<SecuritySettings> getParserForType()
Returns
Type Description
Parser<SecuritySettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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).

repeated string subject_alt_names = 330029535;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
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).

repeated string subject_alt_names = 330029535;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
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).

repeated string subject_alt_names = 330029535;

Returns
Type Description
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).

repeated string subject_alt_names = 330029535;

Returns
Type Description
ProtocolStringList

A list containing the subjectAltNames.

hasAwsV4Authentication()

public boolean hasAwsV4Authentication()

The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.

optional .google.cloud.compute.v1.AWSV4Signature aws_v4_authentication = 433993111;

Returns
Type Description
boolean

Whether the awsV4Authentication field is set.

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.

optional string client_tls_policy = 462325226;

Returns
Type Description
boolean

Whether the clientTlsPolicy field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SecuritySettings.Builder newBuilderForType()
Returns
Type Description
SecuritySettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecuritySettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SecuritySettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SecuritySettings.Builder toBuilder()
Returns
Type Description
SecuritySettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException