@Generated(value="software.amazon.awssdk:codegen") public final class ApiCache extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApiCache.Builder,ApiCache>
The ApiCache
object.
Modifier and Type | Class and Description |
---|---|
static interface |
ApiCache.Builder |
Modifier and Type | Method and Description |
---|---|
ApiCachingBehavior |
apiCachingBehavior()
Caching behavior.
|
String |
apiCachingBehaviorAsString()
Caching behavior.
|
Boolean |
atRestEncryptionEnabled()
At rest encryption flag for cache.
|
static ApiCache.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ApiCache.Builder> |
serializableBuilderClass() |
ApiCacheStatus |
status()
The cache instance status.
|
String |
statusAsString()
The cache instance status.
|
ApiCache.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Boolean |
transitEncryptionEnabled()
Transit encryption flag when connecting to cache.
|
Long |
ttl()
TTL in seconds for cache entries.
|
ApiCacheType |
type()
The cache instance type.
|
String |
typeAsString()
The cache instance type.
|
copy
public final Long ttl()
TTL in seconds for cache entries.
Valid values are between 1 and 3600 seconds.
Valid values are between 1 and 3600 seconds.
public final ApiCachingBehavior apiCachingBehavior()
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
If the service returns an enum value that is not available in the current SDK version,
apiCachingBehavior
will return ApiCachingBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from apiCachingBehaviorAsString()
.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
ApiCachingBehavior
public final String apiCachingBehaviorAsString()
Caching behavior.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
If the service returns an enum value that is not available in the current SDK version,
apiCachingBehavior
will return ApiCachingBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from apiCachingBehaviorAsString()
.
FULL_REQUEST_CACHING: All requests are fully cached.
PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
ApiCachingBehavior
public final Boolean transitEncryptionEnabled()
Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
public final Boolean atRestEncryptionEnabled()
At rest encryption flag for cache. This setting cannot be updated after creation.
public final ApiCacheType type()
The cache instance type. Valid values are
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X
(not available in all regions)
LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
T2_SMALL: A t2.small instance type.
T2_MEDIUM: A t2.medium instance type.
R4_LARGE: A r4.large instance type.
R4_XLARGE: A r4.xlarge instance type.
R4_2XLARGE: A r4.2xlarge instance type.
R4_4XLARGE: A r4.4xlarge instance type.
R4_8XLARGE: A r4.8xlarge instance type.
If the service returns an enum value that is not available in the current SDK version, type
will return
ApiCacheType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X
(not available in all regions)
LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
T2_SMALL: A t2.small instance type.
T2_MEDIUM: A t2.medium instance type.
R4_LARGE: A r4.large instance type.
R4_XLARGE: A r4.xlarge instance type.
R4_2XLARGE: A r4.2xlarge instance type.
R4_4XLARGE: A r4.4xlarge instance type.
R4_8XLARGE: A r4.8xlarge instance type.
ApiCacheType
public final String typeAsString()
The cache instance type. Valid values are
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X
(not available in all regions)
LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
T2_SMALL: A t2.small instance type.
T2_MEDIUM: A t2.medium instance type.
R4_LARGE: A r4.large instance type.
R4_XLARGE: A r4.xlarge instance type.
R4_2XLARGE: A r4.2xlarge instance type.
R4_4XLARGE: A r4.4xlarge instance type.
R4_8XLARGE: A r4.8xlarge instance type.
If the service returns an enum value that is not available in the current SDK version, type
will return
ApiCacheType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
SMALL
MEDIUM
LARGE
XLARGE
LARGE_2X
LARGE_4X
LARGE_8X
(not available in all regions)
LARGE_12X
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.
The following legacy instance types are available, but their use is discouraged:
T2_SMALL: A t2.small instance type.
T2_MEDIUM: A t2.medium instance type.
R4_LARGE: A r4.large instance type.
R4_XLARGE: A r4.xlarge instance type.
R4_2XLARGE: A r4.2xlarge instance type.
R4_4XLARGE: A r4.4xlarge instance type.
R4_8XLARGE: A r4.8xlarge instance type.
ApiCacheType
public final ApiCacheStatus status()
The cache instance status.
AVAILABLE: The instance is available for use.
CREATING: The instance is currently creating.
DELETING: The instance is currently deleting.
MODIFYING: The instance is currently modifying.
FAILED: The instance has failed creation.
If the service returns an enum value that is not available in the current SDK version, status
will
return ApiCacheStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
AVAILABLE: The instance is available for use.
CREATING: The instance is currently creating.
DELETING: The instance is currently deleting.
MODIFYING: The instance is currently modifying.
FAILED: The instance has failed creation.
ApiCacheStatus
public final String statusAsString()
The cache instance status.
AVAILABLE: The instance is available for use.
CREATING: The instance is currently creating.
DELETING: The instance is currently deleting.
MODIFYING: The instance is currently modifying.
FAILED: The instance has failed creation.
If the service returns an enum value that is not available in the current SDK version, status
will
return ApiCacheStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
AVAILABLE: The instance is available for use.
CREATING: The instance is currently creating.
DELETING: The instance is currently deleting.
MODIFYING: The instance is currently modifying.
FAILED: The instance has failed creation.
ApiCacheStatus
public ApiCache.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ApiCache.Builder,ApiCache>
public static ApiCache.Builder builder()
public static Class<? extends ApiCache.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()