Class SslPolicy (1.49.0)

public final class SslPolicy extends GeneratedMessageV3 implements SslPolicyOrBuilder

Represents an SSL Policy resource. Use SSL policies to control SSL features, such as versions and cipher suites, that are offered by Application Load Balancers and proxy Network Load Balancers. For more information, read SSL policies overview.

Protobuf type google.cloud.compute.v1.SslPolicy

Implements

SslPolicyOrBuilder

Static Fields

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_FEATURES_FIELD_NUMBER

public static final int CUSTOM_FEATURES_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLED_FEATURES_FIELD_NUMBER

public static final int ENABLED_FEATURES_FIELD_NUMBER
Field Value
TypeDescription
int

FINGERPRINT_FIELD_NUMBER

public static final int FINGERPRINT_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_TLS_VERSION_FIELD_NUMBER

public static final int MIN_TLS_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROFILE_FIELD_NUMBER

public static final int PROFILE_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

WARNINGS_FIELD_NUMBER

public static final int WARNINGS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SslPolicy getDefaultInstance()
Returns
TypeDescription
SslPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(SslPolicy prototype)

public static SslPolicy.Builder newBuilder(SslPolicy prototype)
Parameter
NameDescription
prototypeSslPolicy
Returns
TypeDescription
SslPolicy.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getCustomFeatures(int index)

public String getCustomFeatures(int index)

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

repeated string custom_features = 34789707;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The customFeatures at the given index.

getCustomFeaturesBytes(int index)

public ByteString getCustomFeaturesBytes(int index)

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

repeated string custom_features = 34789707;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the customFeatures at the given index.

getCustomFeaturesCount()

public int getCustomFeaturesCount()

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

repeated string custom_features = 34789707;

Returns
TypeDescription
int

The count of customFeatures.

getCustomFeaturesList()

public ProtocolStringList getCustomFeaturesList()

A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.

repeated string custom_features = 34789707;

Returns
TypeDescription
ProtocolStringList

A list containing the customFeatures.

getDefaultInstanceForType()

public SslPolicy getDefaultInstanceForType()
Returns
TypeDescription
SslPolicy

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getEnabledFeatures(int index)

public String getEnabledFeatures(int index)

[Output Only] The list of features enabled in the SSL policy.

repeated string enabled_features = 469017467;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The enabledFeatures at the given index.

getEnabledFeaturesBytes(int index)

public ByteString getEnabledFeaturesBytes(int index)

[Output Only] The list of features enabled in the SSL policy.

repeated string enabled_features = 469017467;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the enabledFeatures at the given index.

getEnabledFeaturesCount()

public int getEnabledFeaturesCount()

[Output Only] The list of features enabled in the SSL policy.

repeated string enabled_features = 469017467;

Returns
TypeDescription
int

The count of enabledFeatures.

getEnabledFeaturesList()

public ProtocolStringList getEnabledFeaturesList()

[Output Only] The list of features enabled in the SSL policy.

repeated string enabled_features = 469017467;

Returns
TypeDescription
ProtocolStringList

A list containing the enabledFeatures.

getFingerprint()

public String getFingerprint()

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

optional string fingerprint = 234678500;

Returns
TypeDescription
String

The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

optional string fingerprint = 234678500;

Returns
TypeDescription
ByteString

The bytes for fingerprint.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getKind()

public String getKind()

[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getMinTlsVersion()

public String getMinTlsVersion()

The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. Check the MinTlsVersion enum for the list of possible values.

optional string min_tls_version = 8155943;

Returns
TypeDescription
String

The minTlsVersion.

getMinTlsVersionBytes()

public ByteString getMinTlsVersionBytes()

The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. Check the MinTlsVersion enum for the list of possible values.

optional string min_tls_version = 8155943;

Returns
TypeDescription
ByteString

The bytes for minTlsVersion.

getName()

public String getName()

Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getProfile()

public String getProfile()

Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. Check the Profile enum for the list of possible values.

optional string profile = 227445161;

Returns
TypeDescription
String

The profile.

getProfileBytes()

public ByteString getProfileBytes()

Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. Check the Profile enum for the list of possible values.

optional string profile = 227445161;

Returns
TypeDescription
ByteString

The bytes for profile.

getRegion()

public String getRegion()

[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.

optional string region = 138946292;

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.

optional string region = 138946292;

Returns
TypeDescription
ByteString

The bytes for region.

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getWarnings(int index)

public Warnings getWarnings(int index)

[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Parameter
NameDescription
indexint
Returns
TypeDescription
Warnings

getWarningsCount()

public int getWarningsCount()

[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
TypeDescription
int

getWarningsList()

public List<Warnings> getWarningsList()

[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
TypeDescription
List<Warnings>

getWarningsOrBuilder(int index)

public WarningsOrBuilder getWarningsOrBuilder(int index)

[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Parameter
NameDescription
indexint
Returns
TypeDescription
WarningsOrBuilder

getWarningsOrBuilderList()

public List<? extends WarningsOrBuilder> getWarningsOrBuilderList()

[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.WarningsOrBuilder>

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasFingerprint()

public boolean hasFingerprint()

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.

optional string fingerprint = 234678500;

Returns
TypeDescription
boolean

Whether the fingerprint field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasMinTlsVersion()

public boolean hasMinTlsVersion()

The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. Check the MinTlsVersion enum for the list of possible values.

optional string min_tls_version = 8155943;

Returns
TypeDescription
boolean

Whether the minTlsVersion field is set.

hasName()

public boolean hasName()

Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hasProfile()

public boolean hasProfile()

Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. Check the Profile enum for the list of possible values.

optional string profile = 227445161;

Returns
TypeDescription
boolean

Whether the profile field is set.

hasRegion()

public boolean hasRegion()

[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.

optional string region = 138946292;

Returns
TypeDescription
boolean

Whether the region field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink 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 SslPolicy.Builder newBuilderForType()
Returns
TypeDescription
SslPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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