com.google.api.services.compute.model

Class SslPolicy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.SslPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SslPolicy
extends GenericJson

Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SslPolicy.Warnings Model definition for SslPolicyWarnings.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SslPolicy()

Method Summary

Modifier and Type	Method and Description
SslPolicy	clone()
byte[]	decodeFingerprint() Fingerprint of this resource.
SslPolicy	encodeFingerprint(byte[] fingerprint) Fingerprint of this resource.
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
List<String>	getCustomFeatures() A list of features enabled when the selected profile is CUSTOM.
String	getDescription() An optional description of this resource.
List<String>	getEnabledFeatures() [Output Only] The list of features enabled in the SSL policy.
String	getFingerprint() Fingerprint of this resource.
BigInteger	getId() [Output Only] The unique identifier for the resource.
String	getKind() [Output only] Type of the resource.
String	getMinTlsVersion() The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer.
String	getName() Name of the resource.
String	getProfile() Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients.
String	getRegion() [Output Only] URL of the region where the regional SSL policy resides.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
List<SslPolicy.Warnings>	getWarnings() [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
SslPolicy	set(String fieldName, Object value)
SslPolicy	setCreationTimestamp(String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
SslPolicy	setCustomFeatures(List<String> customFeatures) A list of features enabled when the selected profile is CUSTOM.
SslPolicy	setDescription(String description) An optional description of this resource.
SslPolicy	setEnabledFeatures(List<String> enabledFeatures) [Output Only] The list of features enabled in the SSL policy.
SslPolicy	setFingerprint(String fingerprint) Fingerprint of this resource.
SslPolicy	setId(BigInteger id) [Output Only] The unique identifier for the resource.
SslPolicy	setKind(String kind) [Output only] Type of the resource.
SslPolicy	setMinTlsVersion(String minTlsVersion) The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer.
SslPolicy	setName(String name) Name of the resource.
SslPolicy	setProfile(String profile) Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients.
SslPolicy	setRegion(String region) [Output Only] URL of the region where the regional SSL policy resides.
SslPolicy	setSelfLink(String selfLink) [Output Only] Server-defined URL for the resource.
SslPolicy	setWarnings(List<SslPolicy.Warnings> warnings) [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SslPolicy

public SslPolicy()

Method Detail

getCreationTimestamp

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public SslPolicy setCreationTimestamp(String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp or null for none

getCustomFeatures

public List<String> getCustomFeatures()

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.

Returns:

value or null for none

setCustomFeatures

public SslPolicy setCustomFeatures(List<String> customFeatures)

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.

Parameters:

customFeatures - customFeatures or null for none

getDescription

public String getDescription()

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

Returns:

value or null for none

setDescription

public SslPolicy setDescription(String description)

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

Parameters:

description - description or null for none

getEnabledFeatures

public List<String> getEnabledFeatures()

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

Returns:

value or null for none

setEnabledFeatures

public SslPolicy setEnabledFeatures(List<String> enabledFeatures)

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

Parameters:

enabledFeatures - enabledFeatures or null for none

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.

Returns:

value or null for none

See Also:

decodeFingerprint()

decodeFingerprint

public byte[] decodeFingerprint()

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.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getFingerprint()

setFingerprint

public SslPolicy setFingerprint(String fingerprint)

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.

Parameters:

fingerprint - fingerprint or null for none

See Also:

#encodeFingerprint()

encodeFingerprint

public SslPolicy encodeFingerprint(byte[] fingerprint)

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.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getId

public BigInteger getId()

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

Returns:

value or null for none

setId

public SslPolicy setId(BigInteger id)

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

Parameters:

id - id or null for none

getKind

public String getKind()

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

Returns:

value or null for none

setKind

public SslPolicy setKind(String kind)

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

Parameters:

kind - kind or null for none

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.

Returns:

value or null for none

setMinTlsVersion

public SslPolicy setMinTlsVersion(String minTlsVersion)

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.

Parameters:

minTlsVersion - minTlsVersion or null for none

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]([-a-z0-9]*[a-z0-9])?` 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.

Returns:

value or null for none

setName

public SslPolicy setName(String name)

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]([-a-z0-9]*[a-z0-9])?` 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.

Parameters:

name - name or null for none

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.

Returns:

value or null for none

setProfile

public SslPolicy setProfile(String profile)

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.

Parameters:

profile - profile or null for none

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.

Returns:

value or null for none

setRegion

public SslPolicy setRegion(String region)

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

Parameters:

region - region or null for none

getSelfLink

public String getSelfLink()

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

Returns:

value or null for none

setSelfLink

public SslPolicy setSelfLink(String selfLink)

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

Parameters:

selfLink - selfLink or null for none

getWarnings

public List<SslPolicy.Warnings> getWarnings()

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

Returns:

value or null for none

setWarnings

public SslPolicy setWarnings(List<SslPolicy.Warnings> warnings)

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

Parameters:

warnings - warnings or null for none

set

public SslPolicy set(String fieldName,
                     Object value)

Overrides:

set in class GenericJson

clone

public SslPolicy clone()

Overrides:

clone in class GenericJson