software.amazon.awssdk.services.storagegateway.model

Class RefreshCacheRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.RefreshCacheRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RefreshCacheRequest.Builder,RefreshCacheRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RefreshCacheRequest
extends StorageGatewayRequest
implements ToCopyableBuilder<RefreshCacheRequest.Builder,RefreshCacheRequest>

RefreshCacheInput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RefreshCacheRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RefreshCacheRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileShareARN() The Amazon Resource Name (ARN) of the file share you want to refresh.
List<String>	folderList() A comma-separated list of the paths of folders to refresh in the cache.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFolderList() For responses, this returns true if the service returned a value for the FolderList property.
int	hashCode()
Boolean	recursive() A value that specifies whether to recursively refresh folders in the cache.
List<SdkField<?>>	sdkFields()
static Class<? extends RefreshCacheRequest.Builder>	serializableBuilderClass()
RefreshCacheRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fileShareARN

public final String fileShareARN()

The Amazon Resource Name (ARN) of the file share you want to refresh.

Returns:

The Amazon Resource Name (ARN) of the file share you want to refresh.

hasFolderList

public final boolean hasFolderList()

For responses, this returns true if the service returned a value for the FolderList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

folderList

public final List<String> folderList()

A comma-separated list of the paths of folders to refresh in the cache. The default is ["/"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access to is refreshed.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFolderList() method.

Returns:

A comma-separated list of the paths of folders to refresh in the cache. The default is ["/" ]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access to is refreshed.

recursive

public final Boolean recursive()

A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to true, each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true.

Valid Values: true | false

Returns:

A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to true, each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true.

Valid Values: true | false

toBuilder

public RefreshCacheRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RefreshCacheRequest.Builder,RefreshCacheRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static RefreshCacheRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RefreshCacheRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo