software.amazon.awssdk.services.storagegateway.StorageGatewayAsyncClient Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.storagegateway;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.storagegateway.model.ActivateGatewayRequest;
import software.amazon.awssdk.services.storagegateway.model.ActivateGatewayResponse;
import software.amazon.awssdk.services.storagegateway.model.AddCacheRequest;
import software.amazon.awssdk.services.storagegateway.model.AddCacheResponse;
import software.amazon.awssdk.services.storagegateway.model.AddTagsToResourceRequest;
import software.amazon.awssdk.services.storagegateway.model.AddTagsToResourceResponse;
import software.amazon.awssdk.services.storagegateway.model.AddUploadBufferRequest;
import software.amazon.awssdk.services.storagegateway.model.AddUploadBufferResponse;
import software.amazon.awssdk.services.storagegateway.model.AddWorkingStorageRequest;
import software.amazon.awssdk.services.storagegateway.model.AddWorkingStorageResponse;
import software.amazon.awssdk.services.storagegateway.model.AssignTapePoolRequest;
import software.amazon.awssdk.services.storagegateway.model.AssignTapePoolResponse;
import software.amazon.awssdk.services.storagegateway.model.AttachVolumeRequest;
import software.amazon.awssdk.services.storagegateway.model.AttachVolumeResponse;
import software.amazon.awssdk.services.storagegateway.model.CancelArchivalRequest;
import software.amazon.awssdk.services.storagegateway.model.CancelArchivalResponse;
import software.amazon.awssdk.services.storagegateway.model.CancelRetrievalRequest;
import software.amazon.awssdk.services.storagegateway.model.CancelRetrievalResponse;
import software.amazon.awssdk.services.storagegateway.model.CreateCachediScsiVolumeRequest;
import software.amazon.awssdk.services.storagegateway.model.CreateCachediScsiVolumeResponse;
import software.amazon.awssdk.services.storagegateway.model.CreateNfsFileShareRequest;
import software.amazon.awssdk.services.storagegateway.model.CreateNfsFileShareResponse;
import software.amazon.awssdk.services.storagegateway.model.CreateSmbFileShareRequest;
import software.amazon.awssdk.services.storagegateway.model.CreateSmbFileShareResponse;
import software.amazon.awssdk.services.storagegateway.model.CreateSnapshotFromVolumeRecoveryPointRequest;
import software.amazon.awssdk.services.storagegateway.model.CreateSnapshotFromVolumeRecoveryPointResponse;
import software.amazon.awssdk.services.storagegateway.model.CreateSnapshotRequest;
import software.amazon.awssdk.services.storagegateway.model.CreateSnapshotResponse;
import software.amazon.awssdk.services.storagegateway.model.CreateStorediScsiVolumeRequest;
import software.amazon.awssdk.services.storagegateway.model.CreateStorediScsiVolumeResponse;
import software.amazon.awssdk.services.storagegateway.model.CreateTapeWithBarcodeRequest;
import software.amazon.awssdk.services.storagegateway.model.CreateTapeWithBarcodeResponse;
import software.amazon.awssdk.services.storagegateway.model.CreateTapesRequest;
import software.amazon.awssdk.services.storagegateway.model.CreateTapesResponse;
import software.amazon.awssdk.services.storagegateway.model.DeleteBandwidthRateLimitRequest;
import software.amazon.awssdk.services.storagegateway.model.DeleteBandwidthRateLimitResponse;
import software.amazon.awssdk.services.storagegateway.model.DeleteChapCredentialsRequest;
import software.amazon.awssdk.services.storagegateway.model.DeleteChapCredentialsResponse;
import software.amazon.awssdk.services.storagegateway.model.DeleteFileShareRequest;
import software.amazon.awssdk.services.storagegateway.model.DeleteFileShareResponse;
import software.amazon.awssdk.services.storagegateway.model.DeleteGatewayRequest;
import software.amazon.awssdk.services.storagegateway.model.DeleteGatewayResponse;
import software.amazon.awssdk.services.storagegateway.model.DeleteSnapshotScheduleRequest;
import software.amazon.awssdk.services.storagegateway.model.DeleteSnapshotScheduleResponse;
import software.amazon.awssdk.services.storagegateway.model.DeleteTapeArchiveRequest;
import software.amazon.awssdk.services.storagegateway.model.DeleteTapeArchiveResponse;
import software.amazon.awssdk.services.storagegateway.model.DeleteTapeRequest;
import software.amazon.awssdk.services.storagegateway.model.DeleteTapeResponse;
import software.amazon.awssdk.services.storagegateway.model.DeleteVolumeRequest;
import software.amazon.awssdk.services.storagegateway.model.DeleteVolumeResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeAvailabilityMonitorTestRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeAvailabilityMonitorTestResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeBandwidthRateLimitRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeBandwidthRateLimitResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeCacheRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeCacheResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeCachediScsiVolumesRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeCachediScsiVolumesResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeChapCredentialsRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeChapCredentialsResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeGatewayInformationRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeGatewayInformationResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeMaintenanceStartTimeRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeMaintenanceStartTimeResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeNfsFileSharesRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeNfsFileSharesResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeSmbFileSharesRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeSmbFileSharesResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeSmbSettingsRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeSmbSettingsResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeSnapshotScheduleRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeSnapshotScheduleResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeStorediScsiVolumesRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeStorediScsiVolumesResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeTapesResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeUploadBufferRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeUploadBufferResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesResponse;
import software.amazon.awssdk.services.storagegateway.model.DescribeWorkingStorageRequest;
import software.amazon.awssdk.services.storagegateway.model.DescribeWorkingStorageResponse;
import software.amazon.awssdk.services.storagegateway.model.DetachVolumeRequest;
import software.amazon.awssdk.services.storagegateway.model.DetachVolumeResponse;
import software.amazon.awssdk.services.storagegateway.model.DisableGatewayRequest;
import software.amazon.awssdk.services.storagegateway.model.DisableGatewayResponse;
import software.amazon.awssdk.services.storagegateway.model.JoinDomainRequest;
import software.amazon.awssdk.services.storagegateway.model.JoinDomainResponse;
import software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest;
import software.amazon.awssdk.services.storagegateway.model.ListFileSharesResponse;
import software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest;
import software.amazon.awssdk.services.storagegateway.model.ListGatewaysResponse;
import software.amazon.awssdk.services.storagegateway.model.ListLocalDisksRequest;
import software.amazon.awssdk.services.storagegateway.model.ListLocalDisksResponse;
import software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.storagegateway.model.ListTapesRequest;
import software.amazon.awssdk.services.storagegateway.model.ListTapesResponse;
import software.amazon.awssdk.services.storagegateway.model.ListVolumeInitiatorsRequest;
import software.amazon.awssdk.services.storagegateway.model.ListVolumeInitiatorsResponse;
import software.amazon.awssdk.services.storagegateway.model.ListVolumeRecoveryPointsRequest;
import software.amazon.awssdk.services.storagegateway.model.ListVolumeRecoveryPointsResponse;
import software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest;
import software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse;
import software.amazon.awssdk.services.storagegateway.model.NotifyWhenUploadedRequest;
import software.amazon.awssdk.services.storagegateway.model.NotifyWhenUploadedResponse;
import software.amazon.awssdk.services.storagegateway.model.RefreshCacheRequest;
import software.amazon.awssdk.services.storagegateway.model.RefreshCacheResponse;
import software.amazon.awssdk.services.storagegateway.model.RemoveTagsFromResourceRequest;
import software.amazon.awssdk.services.storagegateway.model.RemoveTagsFromResourceResponse;
import software.amazon.awssdk.services.storagegateway.model.ResetCacheRequest;
import software.amazon.awssdk.services.storagegateway.model.ResetCacheResponse;
import software.amazon.awssdk.services.storagegateway.model.RetrieveTapeArchiveRequest;
import software.amazon.awssdk.services.storagegateway.model.RetrieveTapeArchiveResponse;
import software.amazon.awssdk.services.storagegateway.model.RetrieveTapeRecoveryPointRequest;
import software.amazon.awssdk.services.storagegateway.model.RetrieveTapeRecoveryPointResponse;
import software.amazon.awssdk.services.storagegateway.model.SetLocalConsolePasswordRequest;
import software.amazon.awssdk.services.storagegateway.model.SetLocalConsolePasswordResponse;
import software.amazon.awssdk.services.storagegateway.model.SetSmbGuestPasswordRequest;
import software.amazon.awssdk.services.storagegateway.model.SetSmbGuestPasswordResponse;
import software.amazon.awssdk.services.storagegateway.model.ShutdownGatewayRequest;
import software.amazon.awssdk.services.storagegateway.model.ShutdownGatewayResponse;
import software.amazon.awssdk.services.storagegateway.model.StartAvailabilityMonitorTestRequest;
import software.amazon.awssdk.services.storagegateway.model.StartAvailabilityMonitorTestResponse;
import software.amazon.awssdk.services.storagegateway.model.StartGatewayRequest;
import software.amazon.awssdk.services.storagegateway.model.StartGatewayResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateBandwidthRateLimitRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateBandwidthRateLimitResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateChapCredentialsRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateChapCredentialsResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateGatewayInformationRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateGatewayInformationResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateGatewaySoftwareNowRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateGatewaySoftwareNowResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateMaintenanceStartTimeRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateMaintenanceStartTimeResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateNfsFileShareRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateNfsFileShareResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateSmbFileShareRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateSmbFileShareResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateSmbSecurityStrategyRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateSmbSecurityStrategyResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateSnapshotScheduleRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateSnapshotScheduleResponse;
import software.amazon.awssdk.services.storagegateway.model.UpdateVtlDeviceTypeRequest;
import software.amazon.awssdk.services.storagegateway.model.UpdateVtlDeviceTypeResponse;
import software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher;
import software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsPublisher;
import software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesPublisher;
import software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesPublisher;
import software.amazon.awssdk.services.storagegateway.paginators.ListFileSharesPublisher;
import software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysPublisher;
import software.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourcePublisher;
import software.amazon.awssdk.services.storagegateway.paginators.ListTapesPublisher;
import software.amazon.awssdk.services.storagegateway.paginators.ListVolumesPublisher;
/**
* Service client for accessing AWS Storage Gateway asynchronously. This can be created using the static
* {@link #builder()} method.
*
* AWS Storage Gateway Service
*
* AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to
* provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage
* infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid
* disaster recovery.
*
*
* Use the following links to get started using the AWS Storage Gateway Service API Reference:
*
*
* -
*
* AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST
* request to AWS Storage Gateway.
*
*
* -
*
* Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic
* describes how sign such a request.
*
*
* -
*
*
* Error Responses: Provides reference information about AWS Storage Gateway errors.
*
*
* -
*
* Operations in AWS
* Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters,
* response elements, possible errors, and examples of requests and responses.
*
*
* -
*
* AWS Storage Gateway Regions and
* Endpoints: Provides a list of each AWS Region and the endpoints available for use with AWS Storage Gateway.
*
*
*
*
*
* AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2
* expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For
* example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID
* with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave
* as expected.
*
*
*
* IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer
* format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting
* in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more
* information, see Longer EC2 and EBS Resource IDs.
*
*
* For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:
*
*
* arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
*
*
* A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.
*
*
* For more information, see Announcement: Heads-up – Longer
* AWS Storage Gateway volume and snapshot IDs coming in 2016.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface StorageGatewayAsyncClient extends SdkClient {
String SERVICE_NAME = "storagegateway";
/**
* Create a {@link StorageGatewayAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static StorageGatewayAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link StorageGatewayAsyncClient}.
*/
static StorageGatewayAsyncClientBuilder builder() {
return new DefaultStorageGatewayAsyncClientBuilder();
}
/**
*
* Activates the gateway you previously deployed on your host. In the activation process, you specify information
* such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots
* the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also
* associates your gateway with your account; for more information, see UpdateGatewayInformation.
*
*
*
* You must turn on the gateway VM before you can activate your gateway.
*
*
*
* @param activateGatewayRequest
* A JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the ActivateGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ActivateGateway
* @see AWS
* API Documentation
*/
default CompletableFuture activateGateway(ActivateGatewayRequest activateGatewayRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Activates the gateway you previously deployed on your host. In the activation process, you specify information
* such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots
* the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also
* associates your gateway with your account; for more information, see UpdateGatewayInformation.
*
*
*
* You must turn on the gateway VM before you can activate your gateway.
*
*
*
* This is a convenience which creates an instance of the {@link ActivateGatewayRequest.Builder} avoiding the need
* to create one manually via {@link ActivateGatewayRequest#builder()}
*
*
* @param activateGatewayRequest
* A {@link Consumer} that will call methods on {@link ActivateGatewayInput.Builder} to create a request. A
* JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the ActivateGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ActivateGateway
* @see AWS
* API Documentation
*/
default CompletableFuture activateGateway(
Consumer activateGatewayRequest) {
return activateGateway(ActivateGatewayRequest.builder().applyMutation(activateGatewayRequest).build());
}
/**
*
* Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached
* volume, tape and file gateway type (see Storage Gateway
* Concepts).
*
*
* In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or
* more disk IDs that you want to configure as cache.
*
*
* @param addCacheRequest
* @return A Java Future containing the result of the AddCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AddCache
* @see AWS API
* Documentation
*/
default CompletableFuture addCache(AddCacheRequest addCacheRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached
* volume, tape and file gateway type (see Storage Gateway
* Concepts).
*
*
* In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or
* more disk IDs that you want to configure as cache.
*
*
*
* This is a convenience which creates an instance of the {@link AddCacheRequest.Builder} avoiding the need to
* create one manually via {@link AddCacheRequest#builder()}
*
*
* @param addCacheRequest
* A {@link Consumer} that will call methods on {@link AddCacheInput.Builder} to create a request.
* @return A Java Future containing the result of the AddCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AddCache
* @see AWS API
* Documentation
*/
default CompletableFuture addCache(Consumer addCacheRequest) {
return addCache(AddCacheRequest.builder().applyMutation(addCacheRequest).build());
}
/**
*
* Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to
* categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team.
* Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway
* resources:
*
*
* -
*
* Storage gateways of all types
*
*
* -
*
* Storage volumes
*
*
* -
*
* Virtual tapes
*
*
* -
*
* NFS and SMB file shares
*
*
*
*
* You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a
* new gateway maintain their tags.
*
*
* @param addTagsToResourceRequest
* AddTagsToResourceInput
* @return A Java Future containing the result of the AddTagsToResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AddTagsToResource
* @see AWS API Documentation
*/
default CompletableFuture addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to
* categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team.
* Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway
* resources:
*
*
* -
*
* Storage gateways of all types
*
*
* -
*
* Storage volumes
*
*
* -
*
* Virtual tapes
*
*
* -
*
* NFS and SMB file shares
*
*
*
*
* You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a
* new gateway maintain their tags.
*
*
*
* This is a convenience which creates an instance of the {@link AddTagsToResourceRequest.Builder} avoiding the need
* to create one manually via {@link AddTagsToResourceRequest#builder()}
*
*
* @param addTagsToResourceRequest
* A {@link Consumer} that will call methods on {@link AddTagsToResourceInput.Builder} to create a request.
* AddTagsToResourceInput
* @return A Java Future containing the result of the AddTagsToResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AddTagsToResource
* @see AWS API Documentation
*/
default CompletableFuture addTagsToResource(
Consumer addTagsToResourceRequest) {
return addTagsToResource(AddTagsToResourceRequest.builder().applyMutation(addTagsToResourceRequest).build());
}
/**
*
* Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported
* for the stored volume, cached volume and tape gateway types.
*
*
* In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and
* one or more disk IDs that you want to configure as upload buffer.
*
*
* @param addUploadBufferRequest
* @return A Java Future containing the result of the AddUploadBuffer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AddUploadBuffer
* @see AWS
* API Documentation
*/
default CompletableFuture addUploadBuffer(AddUploadBufferRequest addUploadBufferRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported
* for the stored volume, cached volume and tape gateway types.
*
*
* In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and
* one or more disk IDs that you want to configure as upload buffer.
*
*
*
* This is a convenience which creates an instance of the {@link AddUploadBufferRequest.Builder} avoiding the need
* to create one manually via {@link AddUploadBufferRequest#builder()}
*
*
* @param addUploadBufferRequest
* A {@link Consumer} that will call methods on {@link AddUploadBufferInput.Builder} to create a request.
* @return A Java Future containing the result of the AddUploadBuffer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AddUploadBuffer
* @see AWS
* API Documentation
*/
default CompletableFuture addUploadBuffer(
Consumer addUploadBufferRequest) {
return addUploadBuffer(AddUploadBufferRequest.builder().applyMutation(addUploadBufferRequest).build());
}
/**
*
* Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in
* the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use
* AddUploadBuffer instead.
*
*
*
* Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to
* add upload buffer to a stored volume gateway.
*
*
*
* In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and
* one or more disk IDs that you want to configure as working storage.
*
*
* @param addWorkingStorageRequest
* A JSON object containing one or more of the following fields:
*
* -
*
*
* @return A Java Future containing the result of the AddWorkingStorage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AddWorkingStorage
* @see AWS API Documentation
*/
default CompletableFuture addWorkingStorage(AddWorkingStorageRequest addWorkingStorageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in
* the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use
* AddUploadBuffer instead.
*
*
*
* Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to
* add upload buffer to a stored volume gateway.
*
*
*
* In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and
* one or more disk IDs that you want to configure as working storage.
*
*
*
* This is a convenience which creates an instance of the {@link AddWorkingStorageRequest.Builder} avoiding the need
* to create one manually via {@link AddWorkingStorageRequest#builder()}
*
*
* @param addWorkingStorageRequest
* A {@link Consumer} that will call methods on {@link AddWorkingStorageInput.Builder} to create a request. A
* JSON object containing one or more of the following fields:
*
* -
*
*
* @return A Java Future containing the result of the AddWorkingStorage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AddWorkingStorage
* @see AWS API Documentation
*/
default CompletableFuture addWorkingStorage(
Consumer addWorkingStorageRequest) {
return addWorkingStorage(AddWorkingStorageRequest.builder().applyMutation(addWorkingStorageRequest).build());
}
/**
*
* Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that
* is associated with the pool. When you use your backup application to eject the tape, the tape is archived
* directly into the S3 storage class (Glacier or Deep Archive) that corresponds to the pool.
*
*
* Valid values: "GLACIER", "DEEP_ARCHIVE"
*
*
* @param assignTapePoolRequest
* @return A Java Future containing the result of the AssignTapePool operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AssignTapePool
* @see AWS
* API Documentation
*/
default CompletableFuture assignTapePool(AssignTapePoolRequest assignTapePoolRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that
* is associated with the pool. When you use your backup application to eject the tape, the tape is archived
* directly into the S3 storage class (Glacier or Deep Archive) that corresponds to the pool.
*
*
* Valid values: "GLACIER", "DEEP_ARCHIVE"
*
*
*
* This is a convenience which creates an instance of the {@link AssignTapePoolRequest.Builder} avoiding the need to
* create one manually via {@link AssignTapePoolRequest#builder()}
*
*
* @param assignTapePoolRequest
* A {@link Consumer} that will call methods on {@link AssignTapePoolInput.Builder} to create a request.
* @return A Java Future containing the result of the AssignTapePool operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AssignTapePool
* @see AWS
* API Documentation
*/
default CompletableFuture assignTapePool(Consumer assignTapePoolRequest) {
return assignTapePool(AssignTapePoolRequest.builder().applyMutation(assignTapePoolRequest).build());
}
/**
*
* Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and
* attaching a volume enables you to recover your data from one gateway to a different gateway without creating a
* snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an
* Amazon EC2 instance.
*
*
* @param attachVolumeRequest
* AttachVolumeInput
* @return A Java Future containing the result of the AttachVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AttachVolume
* @see AWS
* API Documentation
*/
default CompletableFuture attachVolume(AttachVolumeRequest attachVolumeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and
* attaching a volume enables you to recover your data from one gateway to a different gateway without creating a
* snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an
* Amazon EC2 instance.
*
*
*
* This is a convenience which creates an instance of the {@link AttachVolumeRequest.Builder} avoiding the need to
* create one manually via {@link AttachVolumeRequest#builder()}
*
*
* @param attachVolumeRequest
* A {@link Consumer} that will call methods on {@link AttachVolumeInput.Builder} to create a request.
* AttachVolumeInput
* @return A Java Future containing the result of the AttachVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.AttachVolume
* @see AWS
* API Documentation
*/
default CompletableFuture attachVolume(Consumer attachVolumeRequest) {
return attachVolume(AttachVolumeRequest.builder().applyMutation(attachVolumeRequest).build());
}
/**
*
* Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
* This operation is only supported in the tape gateway type.
*
*
* @param cancelArchivalRequest
* CancelArchivalInput
* @return A Java Future containing the result of the CancelArchival operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CancelArchival
* @see AWS
* API Documentation
*/
default CompletableFuture cancelArchival(CancelArchivalRequest cancelArchivalRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.
* This operation is only supported in the tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link CancelArchivalRequest.Builder} avoiding the need to
* create one manually via {@link CancelArchivalRequest#builder()}
*
*
* @param cancelArchivalRequest
* A {@link Consumer} that will call methods on {@link CancelArchivalInput.Builder} to create a request.
* CancelArchivalInput
* @return A Java Future containing the result of the CancelArchival operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CancelArchival
* @see AWS
* API Documentation
*/
default CompletableFuture cancelArchival(Consumer cancelArchivalRequest) {
return cancelArchival(CancelArchivalRequest.builder().applyMutation(cancelArchivalRequest).build());
}
/**
*
* Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is
* initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.
*
*
* @param cancelRetrievalRequest
* CancelRetrievalInput
* @return A Java Future containing the result of the CancelRetrieval operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CancelRetrieval
* @see AWS
* API Documentation
*/
default CompletableFuture cancelRetrieval(CancelRetrievalRequest cancelRetrievalRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is
* initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link CancelRetrievalRequest.Builder} avoiding the need
* to create one manually via {@link CancelRetrievalRequest#builder()}
*
*
* @param cancelRetrievalRequest
* A {@link Consumer} that will call methods on {@link CancelRetrievalInput.Builder} to create a request.
* CancelRetrievalInput
* @return A Java Future containing the result of the CancelRetrieval operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CancelRetrieval
* @see AWS
* API Documentation
*/
default CompletableFuture cancelRetrieval(
Consumer cancelRetrievalRequest) {
return cancelRetrieval(CancelRetrievalRequest.builder().applyMutation(cancelRetrievalRequest).build());
}
/**
*
* Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached
* volume gateway type.
*
*
*
* Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache
* operation to add cache storage to a gateway.
*
*
*
* In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address
* on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns
* information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI
* target ARN that initiators can use to connect to the volume target.
*
*
* Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached
* volume, which creates an exact copy of the existing volume’s latest recovery point. The
* VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.
*
*
* @param createCachediScsiVolumeRequest
* @return A Java Future containing the result of the CreateCachediSCSIVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateCachediSCSIVolume
* @see AWS API Documentation
*/
default CompletableFuture createCachediSCSIVolume(
CreateCachediScsiVolumeRequest createCachediScsiVolumeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached
* volume gateway type.
*
*
*
* Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache
* operation to add cache storage to a gateway.
*
*
*
* In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address
* on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns
* information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI
* target ARN that initiators can use to connect to the volume target.
*
*
* Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached
* volume, which creates an exact copy of the existing volume’s latest recovery point. The
* VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.
*
*
*
* This is a convenience which creates an instance of the {@link CreateCachediScsiVolumeRequest.Builder} avoiding
* the need to create one manually via {@link CreateCachediScsiVolumeRequest#builder()}
*
*
* @param createCachediScsiVolumeRequest
* A {@link Consumer} that will call methods on {@link CreateCachediSCSIVolumeInput.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateCachediSCSIVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateCachediSCSIVolume
* @see AWS API Documentation
*/
default CompletableFuture createCachediSCSIVolume(
Consumer createCachediScsiVolumeRequest) {
return createCachediSCSIVolume(CreateCachediScsiVolumeRequest.builder().applyMutation(createCachediScsiVolumeRequest)
.build());
}
/**
*
* Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a
* file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS
* interface. This operation is only supported for file gateways.
*
*
*
* File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share.
* Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not
* activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and
* Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
*
*
* File gateway does not support creating hard or symbolic links on a file share.
*
*
*
* @param createNfsFileShareRequest
* CreateNFSFileShareInput
* @return A Java Future containing the result of the CreateNFSFileShare operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateNFSFileShare
* @see AWS API Documentation
*/
default CompletableFuture createNFSFileShare(CreateNfsFileShareRequest createNfsFileShareRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a
* file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS
* interface. This operation is only supported for file gateways.
*
*
*
* File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share.
* Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not
* activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and
* Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
*
*
* File gateway does not support creating hard or symbolic links on a file share.
*
*
*
* This is a convenience which creates an instance of the {@link CreateNfsFileShareRequest.Builder} avoiding the
* need to create one manually via {@link CreateNfsFileShareRequest#builder()}
*
*
* @param createNfsFileShareRequest
* A {@link Consumer} that will call methods on {@link CreateNFSFileShareInput.Builder} to create a request.
* CreateNFSFileShareInput
* @return A Java Future containing the result of the CreateNFSFileShare operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateNFSFileShare
* @see AWS API Documentation
*/
default CompletableFuture createNFSFileShare(
Consumer createNfsFileShareRequest) {
return createNFSFileShare(CreateNfsFileShareRequest.builder().applyMutation(createNfsFileShareRequest).build());
}
/**
*
* Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is
* a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB
* interface. This operation is only supported for file gateways.
*
*
*
* File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share.
* Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not
* activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and
* Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
*
*
* File gateways don't support creating hard or symbolic links on a file share.
*
*
*
* @param createSmbFileShareRequest
* CreateSMBFileShareInput
* @return A Java Future containing the result of the CreateSMBFileShare operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateSMBFileShare
* @see AWS API Documentation
*/
default CompletableFuture createSMBFileShare(CreateSmbFileShareRequest createSmbFileShareRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is
* a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB
* interface. This operation is only supported for file gateways.
*
*
*
* File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share.
* Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not
* activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and
* Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
*
*
* File gateways don't support creating hard or symbolic links on a file share.
*
*
*
* This is a convenience which creates an instance of the {@link CreateSmbFileShareRequest.Builder} avoiding the
* need to create one manually via {@link CreateSmbFileShareRequest#builder()}
*
*
* @param createSmbFileShareRequest
* A {@link Consumer} that will call methods on {@link CreateSMBFileShareInput.Builder} to create a request.
* CreateSMBFileShareInput
* @return A Java Future containing the result of the CreateSMBFileShare operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateSMBFileShare
* @see AWS API Documentation
*/
default CompletableFuture createSMBFileShare(
Consumer createSmbFileShareRequest) {
return createSMBFileShare(CreateSmbFileShareRequest.builder().applyMutation(createSmbFileShareRequest).build());
}
/**
*
* Initiates a snapshot of a volume.
*
*
* AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage
* (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in
* Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis.
* This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule.
*
*
* In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also
* provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the
* snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you
* a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to
* create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.
*
*
*
* To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or
* DeleteSnapshot in the EC2
* API reference.
*
*
*
* Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note
* on the Welcome page.
*
*
*
* @param createSnapshotRequest
* A JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the CreateSnapshot operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - ServiceUnavailableErrorException An internal server error has occurred because the service is
* unavailable. For more information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateSnapshot
* @see AWS
* API Documentation
*/
default CompletableFuture createSnapshot(CreateSnapshotRequest createSnapshotRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Initiates a snapshot of a volume.
*
*
* AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage
* (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in
* Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis.
* This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule.
*
*
* In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also
* provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the
* snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you
* a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to
* create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.
*
*
*
* To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or
* DeleteSnapshot in the EC2
* API reference.
*
*
*
* Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note
* on the Welcome page.
*
*
*
* This is a convenience which creates an instance of the {@link CreateSnapshotRequest.Builder} avoiding the need to
* create one manually via {@link CreateSnapshotRequest#builder()}
*
*
* @param createSnapshotRequest
* A {@link Consumer} that will call methods on {@link CreateSnapshotInput.Builder} to create a request. A
* JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the CreateSnapshot operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - ServiceUnavailableErrorException An internal server error has occurred because the service is
* unavailable. For more information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateSnapshot
* @see AWS
* API Documentation
*/
default CompletableFuture createSnapshot(Consumer createSnapshotRequest) {
return createSnapshot(CreateSnapshotRequest.builder().applyMutation(createSnapshotRequest).build());
}
/**
*
* Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached
* volume gateway type.
*
*
* A volume recovery point is a point in time at which all data of the volume is consistent and from which you can
* create a snapshot. To get a list of volume recovery point for cached volume gateway, use
* ListVolumeRecoveryPoints.
*
*
* In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its
* Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a
* snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In
* response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or
* later use it when you want to create a volume from a snapshot.
*
*
*
* To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute
* Cloud API Reference.
*
*
*
* @param createSnapshotFromVolumeRecoveryPointRequest
* @return A Java Future containing the result of the CreateSnapshotFromVolumeRecoveryPoint operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - ServiceUnavailableErrorException An internal server error has occurred because the service is
* unavailable. For more information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateSnapshotFromVolumeRecoveryPoint
* @see AWS API Documentation
*/
default CompletableFuture createSnapshotFromVolumeRecoveryPoint(
CreateSnapshotFromVolumeRecoveryPointRequest createSnapshotFromVolumeRecoveryPointRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached
* volume gateway type.
*
*
* A volume recovery point is a point in time at which all data of the volume is consistent and from which you can
* create a snapshot. To get a list of volume recovery point for cached volume gateway, use
* ListVolumeRecoveryPoints.
*
*
* In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its
* Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a
* snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In
* response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or
* later use it when you want to create a volume from a snapshot.
*
*
*
* To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute
* Cloud API Reference.
*
*
*
* This is a convenience which creates an instance of the
* {@link CreateSnapshotFromVolumeRecoveryPointRequest.Builder} avoiding the need to create one manually via
* {@link CreateSnapshotFromVolumeRecoveryPointRequest#builder()}
*
*
* @param createSnapshotFromVolumeRecoveryPointRequest
* A {@link Consumer} that will call methods on {@link CreateSnapshotFromVolumeRecoveryPointInput.Builder} to
* create a request.
* @return A Java Future containing the result of the CreateSnapshotFromVolumeRecoveryPoint operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - ServiceUnavailableErrorException An internal server error has occurred because the service is
* unavailable. For more information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateSnapshotFromVolumeRecoveryPoint
* @see AWS API Documentation
*/
default CompletableFuture createSnapshotFromVolumeRecoveryPoint(
Consumer createSnapshotFromVolumeRecoveryPointRequest) {
return createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest.builder()
.applyMutation(createSnapshotFromVolumeRecoveryPointRequest).build());
}
/**
*
* Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.
*
*
* The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the
* disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty
* gateway volume, then any existing data on the disk is erased.
*
*
* In the request you must specify the gateway and the disk information on which you are creating the volume. In
* response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name
* (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
*
*
* @param createStorediScsiVolumeRequest
* A JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the CreateStorediSCSIVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateStorediSCSIVolume
* @see AWS API Documentation
*/
default CompletableFuture createStorediSCSIVolume(
CreateStorediScsiVolumeRequest createStorediScsiVolumeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.
*
*
* The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the
* disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty
* gateway volume, then any existing data on the disk is erased.
*
*
* In the request you must specify the gateway and the disk information on which you are creating the volume. In
* response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name
* (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.
*
*
*
* This is a convenience which creates an instance of the {@link CreateStorediScsiVolumeRequest.Builder} avoiding
* the need to create one manually via {@link CreateStorediScsiVolumeRequest#builder()}
*
*
* @param createStorediScsiVolumeRequest
* A {@link Consumer} that will call methods on {@link CreateStorediSCSIVolumeInput.Builder} to create a
* request. A JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the CreateStorediSCSIVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateStorediSCSIVolume
* @see AWS API Documentation
*/
default CompletableFuture createStorediSCSIVolume(
Consumer createStorediScsiVolumeRequest) {
return createStorediSCSIVolume(CreateStorediScsiVolumeRequest.builder().applyMutation(createStorediScsiVolumeRequest)
.build());
}
/**
*
* Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A
* barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on
* deleted tapes. This operation is only supported in the tape gateway type.
*
*
*
* Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache
* operation to add cache storage to a gateway.
*
*
*
* @param createTapeWithBarcodeRequest
* CreateTapeWithBarcodeInput
* @return A Java Future containing the result of the CreateTapeWithBarcode operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateTapeWithBarcode
* @see AWS API Documentation
*/
default CompletableFuture createTapeWithBarcode(
CreateTapeWithBarcodeRequest createTapeWithBarcodeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A
* barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on
* deleted tapes. This operation is only supported in the tape gateway type.
*
*
*
* Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache
* operation to add cache storage to a gateway.
*
*
*
* This is a convenience which creates an instance of the {@link CreateTapeWithBarcodeRequest.Builder} avoiding the
* need to create one manually via {@link CreateTapeWithBarcodeRequest#builder()}
*
*
* @param createTapeWithBarcodeRequest
* A {@link Consumer} that will call methods on {@link CreateTapeWithBarcodeInput.Builder} to create a
* request. CreateTapeWithBarcodeInput
* @return A Java Future containing the result of the CreateTapeWithBarcode operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateTapeWithBarcode
* @see AWS API Documentation
*/
default CompletableFuture createTapeWithBarcode(
Consumer createTapeWithBarcodeRequest) {
return createTapeWithBarcode(CreateTapeWithBarcodeRequest.builder().applyMutation(createTapeWithBarcodeRequest).build());
}
/**
*
* Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation
* is only supported in the tape gateway type.
*
*
*
* Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache
* operation to add cache storage to a gateway.
*
*
*
* @param createTapesRequest
* CreateTapesInput
* @return A Java Future containing the result of the CreateTapes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateTapes
* @see AWS API
* Documentation
*/
default CompletableFuture createTapes(CreateTapesRequest createTapesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation
* is only supported in the tape gateway type.
*
*
*
* Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache
* operation to add cache storage to a gateway.
*
*
*
* This is a convenience which creates an instance of the {@link CreateTapesRequest.Builder} avoiding the need to
* create one manually via {@link CreateTapesRequest#builder()}
*
*
* @param createTapesRequest
* A {@link Consumer} that will call methods on {@link CreateTapesInput.Builder} to create a request.
* CreateTapesInput
* @return A Java Future containing the result of the CreateTapes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.CreateTapes
* @see AWS API
* Documentation
*/
default CompletableFuture createTapes(Consumer createTapesRequest) {
return createTapes(CreateTapesRequest.builder().applyMutation(createTapesRequest).build());
}
/**
*
* Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate
* limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To
* specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This
* operation is supported for the stored volume, cached volume and tape gateway types.
*
*
* @param deleteBandwidthRateLimitRequest
* A JSON object containing the following fields:
*
* -
*
*
* @return A Java Future containing the result of the DeleteBandwidthRateLimit operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteBandwidthRateLimit
* @see AWS API Documentation
*/
default CompletableFuture deleteBandwidthRateLimit(
DeleteBandwidthRateLimitRequest deleteBandwidthRateLimitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate
* limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To
* specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This
* operation is supported for the stored volume, cached volume and tape gateway types.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBandwidthRateLimitRequest.Builder} avoiding
* the need to create one manually via {@link DeleteBandwidthRateLimitRequest#builder()}
*
*
* @param deleteBandwidthRateLimitRequest
* A {@link Consumer} that will call methods on {@link DeleteBandwidthRateLimitInput.Builder} to create a
* request. A JSON object containing the following fields:
*
* -
*
*
* @return A Java Future containing the result of the DeleteBandwidthRateLimit operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteBandwidthRateLimit
* @see AWS API Documentation
*/
default CompletableFuture deleteBandwidthRateLimit(
Consumer deleteBandwidthRateLimitRequest) {
return deleteBandwidthRateLimit(DeleteBandwidthRateLimitRequest.builder().applyMutation(deleteBandwidthRateLimitRequest)
.build());
}
/**
*
* Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator
* pair. This operation is supported in volume and tape gateway types.
*
*
* @param deleteChapCredentialsRequest
* A JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the DeleteChapCredentials operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteChapCredentials
* @see AWS API Documentation
*/
default CompletableFuture deleteChapCredentials(
DeleteChapCredentialsRequest deleteChapCredentialsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator
* pair. This operation is supported in volume and tape gateway types.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteChapCredentialsRequest.Builder} avoiding the
* need to create one manually via {@link DeleteChapCredentialsRequest#builder()}
*
*
* @param deleteChapCredentialsRequest
* A {@link Consumer} that will call methods on {@link DeleteChapCredentialsInput.Builder} to create a
* request. A JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the DeleteChapCredentials operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteChapCredentials
* @see AWS API Documentation
*/
default CompletableFuture deleteChapCredentials(
Consumer deleteChapCredentialsRequest) {
return deleteChapCredentials(DeleteChapCredentialsRequest.builder().applyMutation(deleteChapCredentialsRequest).build());
}
/**
*
* Deletes a file share from a file gateway. This operation is only supported for file gateways.
*
*
* @param deleteFileShareRequest
* DeleteFileShareInput
* @return A Java Future containing the result of the DeleteFileShare operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteFileShare
* @see AWS
* API Documentation
*/
default CompletableFuture deleteFileShare(DeleteFileShareRequest deleteFileShareRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a file share from a file gateway. This operation is only supported for file gateways.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteFileShareRequest.Builder} avoiding the need
* to create one manually via {@link DeleteFileShareRequest#builder()}
*
*
* @param deleteFileShareRequest
* A {@link Consumer} that will call methods on {@link DeleteFileShareInput.Builder} to create a request.
* DeleteFileShareInput
* @return A Java Future containing the result of the DeleteFileShare operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteFileShare
* @see AWS
* API Documentation
*/
default CompletableFuture deleteFileShare(
Consumer deleteFileShareRequest) {
return deleteFileShare(DeleteFileShareRequest.builder().applyMutation(deleteFileShareRequest).build());
}
/**
*
* Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your
* request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from
* your host computer.
*
*
* After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted
* upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next
* step is to remove it from your environment.
*
*
*
* You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots
* persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS
* snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription,
* you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.
*
*
*
* @param deleteGatewayRequest
* A JSON object containing the ID of the gateway to delete.
* @return A Java Future containing the result of the DeleteGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteGateway
* @see AWS
* API Documentation
*/
default CompletableFuture deleteGateway(DeleteGatewayRequest deleteGatewayRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your
* request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from
* your host computer.
*
*
* After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted
* upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next
* step is to remove it from your environment.
*
*
*
* You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots
* persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS
* snapshots by canceling your Amazon EC2 subscription. If you prefer not to cancel your Amazon EC2 subscription,
* you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteGatewayRequest.Builder} avoiding the need to
* create one manually via {@link DeleteGatewayRequest#builder()}
*
*
* @param deleteGatewayRequest
* A {@link Consumer} that will call methods on {@link DeleteGatewayInput.Builder} to create a request. A
* JSON object containing the ID of the gateway to delete.
* @return A Java Future containing the result of the DeleteGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteGateway
* @see AWS
* API Documentation
*/
default CompletableFuture deleteGateway(Consumer deleteGatewayRequest) {
return deleteGateway(DeleteGatewayRequest.builder().applyMutation(deleteGatewayRequest).build());
}
/**
*
* Deletes a snapshot of a volume.
*
*
* You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to
* delete a snapshot schedule for a volume. For more information, see Working with
* Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its
* Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.
*
*
*
* To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API
* Reference.
*
*
*
* @param deleteSnapshotScheduleRequest
* @return A Java Future containing the result of the DeleteSnapshotSchedule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteSnapshotSchedule
* @see AWS API Documentation
*/
default CompletableFuture deleteSnapshotSchedule(
DeleteSnapshotScheduleRequest deleteSnapshotScheduleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a snapshot of a volume.
*
*
* You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to
* delete a snapshot schedule for a volume. For more information, see Working with
* Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its
* Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.
*
*
*
* To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API
* Reference.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSnapshotScheduleRequest.Builder} avoiding the
* need to create one manually via {@link DeleteSnapshotScheduleRequest#builder()}
*
*
* @param deleteSnapshotScheduleRequest
* A {@link Consumer} that will call methods on {@link DeleteSnapshotScheduleInput.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteSnapshotSchedule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteSnapshotSchedule
* @see AWS API Documentation
*/
default CompletableFuture deleteSnapshotSchedule(
Consumer deleteSnapshotScheduleRequest) {
return deleteSnapshotSchedule(DeleteSnapshotScheduleRequest.builder().applyMutation(deleteSnapshotScheduleRequest)
.build());
}
/**
*
* Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
*
*
* @param deleteTapeRequest
* DeleteTapeInput
* @return A Java Future containing the result of the DeleteTape operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteTape
* @see AWS API
* Documentation
*/
default CompletableFuture deleteTape(DeleteTapeRequest deleteTapeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified virtual tape. This operation is only supported in the tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteTapeRequest.Builder} avoiding the need to
* create one manually via {@link DeleteTapeRequest#builder()}
*
*
* @param deleteTapeRequest
* A {@link Consumer} that will call methods on {@link DeleteTapeInput.Builder} to create a request.
* DeleteTapeInput
* @return A Java Future containing the result of the DeleteTape operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteTape
* @see AWS API
* Documentation
*/
default CompletableFuture deleteTape(Consumer deleteTapeRequest) {
return deleteTape(DeleteTapeRequest.builder().applyMutation(deleteTapeRequest).build());
}
/**
*
* Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the
* tape gateway type.
*
*
* @param deleteTapeArchiveRequest
* DeleteTapeArchiveInput
* @return A Java Future containing the result of the DeleteTapeArchive operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteTapeArchive
* @see AWS API Documentation
*/
default CompletableFuture deleteTapeArchive(DeleteTapeArchiveRequest deleteTapeArchiveRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the
* tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteTapeArchiveRequest.Builder} avoiding the need
* to create one manually via {@link DeleteTapeArchiveRequest#builder()}
*
*
* @param deleteTapeArchiveRequest
* A {@link Consumer} that will call methods on {@link DeleteTapeArchiveInput.Builder} to create a request.
* DeleteTapeArchiveInput
* @return A Java Future containing the result of the DeleteTapeArchive operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteTapeArchive
* @see AWS API Documentation
*/
default CompletableFuture deleteTapeArchive(
Consumer deleteTapeArchiveRequest) {
return deleteTapeArchive(DeleteTapeArchiveRequest.builder().applyMutation(deleteTapeArchiveRequest).build());
}
/**
*
* Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or
* CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume
* types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You
* can reuse the local disk to create another storage volume.
*
*
* Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should
* also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to
* query snapshots on the volume you are deleting and check the snapshot status. For more information, go to
* DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
*
*
* In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
*
*
* @param deleteVolumeRequest
* A JSON object containing the DeleteVolumeInput$VolumeARN to delete.
* @return A Java Future containing the result of the DeleteVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteVolume
* @see AWS
* API Documentation
*/
default CompletableFuture deleteVolume(DeleteVolumeRequest deleteVolumeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or
* CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume
* types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You
* can reuse the local disk to create another storage volume.
*
*
* Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should
* also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to
* query snapshots on the volume you are deleting and check the snapshot status. For more information, go to
* DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
*
*
* In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteVolumeRequest.Builder} avoiding the need to
* create one manually via {@link DeleteVolumeRequest#builder()}
*
*
* @param deleteVolumeRequest
* A {@link Consumer} that will call methods on {@link DeleteVolumeInput.Builder} to create a request. A JSON
* object containing the DeleteVolumeInput$VolumeARN to delete.
* @return A Java Future containing the result of the DeleteVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DeleteVolume
* @see AWS
* API Documentation
*/
default CompletableFuture deleteVolume(Consumer deleteVolumeRequest) {
return deleteVolume(DeleteVolumeRequest.builder().applyMutation(deleteVolumeRequest).build());
}
/**
*
* Returns information about the most recent High Availability monitoring test that was performed on the host in a
* cluster. If a test isn't performed, the status and start time in the response would be null.
*
*
* @param describeAvailabilityMonitorTestRequest
* @return A Java Future containing the result of the DescribeAvailabilityMonitorTest operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeAvailabilityMonitorTest
* @see AWS API Documentation
*/
default CompletableFuture describeAvailabilityMonitorTest(
DescribeAvailabilityMonitorTestRequest describeAvailabilityMonitorTestRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about the most recent High Availability monitoring test that was performed on the host in a
* cluster. If a test isn't performed, the status and start time in the response would be null.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAvailabilityMonitorTestRequest.Builder}
* avoiding the need to create one manually via {@link DescribeAvailabilityMonitorTestRequest#builder()}
*
*
* @param describeAvailabilityMonitorTestRequest
* A {@link Consumer} that will call methods on {@link DescribeAvailabilityMonitorTestInput.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeAvailabilityMonitorTest operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeAvailabilityMonitorTest
* @see AWS API Documentation
*/
default CompletableFuture describeAvailabilityMonitorTest(
Consumer describeAvailabilityMonitorTestRequest) {
return describeAvailabilityMonitorTest(DescribeAvailabilityMonitorTestRequest.builder()
.applyMutation(describeAvailabilityMonitorTestRequest).build());
}
/**
*
* Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth
* rate limiting is in effect. This operation is supported for the stored volume, cached volume and tape gateway
* types.'
*
*
* This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for
* the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to
* describe, use the Amazon Resource Name (ARN) of the gateway in your request.
*
*
* @param describeBandwidthRateLimitRequest
* A JSON object containing the of the gateway.
* @return A Java Future containing the result of the DescribeBandwidthRateLimit operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeBandwidthRateLimit
* @see AWS API Documentation
*/
default CompletableFuture describeBandwidthRateLimit(
DescribeBandwidthRateLimitRequest describeBandwidthRateLimitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth
* rate limiting is in effect. This operation is supported for the stored volume, cached volume and tape gateway
* types.'
*
*
* This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for
* the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to
* describe, use the Amazon Resource Name (ARN) of the gateway in your request.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeBandwidthRateLimitRequest.Builder} avoiding
* the need to create one manually via {@link DescribeBandwidthRateLimitRequest#builder()}
*
*
* @param describeBandwidthRateLimitRequest
* A {@link Consumer} that will call methods on {@link DescribeBandwidthRateLimitInput.Builder} to create a
* request. A JSON object containing the of the gateway.
* @return A Java Future containing the result of the DescribeBandwidthRateLimit operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeBandwidthRateLimit
* @see AWS API Documentation
*/
default CompletableFuture describeBandwidthRateLimit(
Consumer describeBandwidthRateLimitRequest) {
return describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest.builder()
.applyMutation(describeBandwidthRateLimitRequest).build());
}
/**
*
* Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and
* file gateway types.
*
*
* The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and
* used.
*
*
* @param describeCacheRequest
* @return A Java Future containing the result of the DescribeCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeCache
* @see AWS
* API Documentation
*/
default CompletableFuture describeCache(DescribeCacheRequest describeCacheRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and
* file gateway types.
*
*
* The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and
* used.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCacheRequest.Builder} avoiding the need to
* create one manually via {@link DescribeCacheRequest#builder()}
*
*
* @param describeCacheRequest
* A {@link Consumer} that will call methods on {@link DescribeCacheInput.Builder} to create a request.
* @return A Java Future containing the result of the DescribeCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeCache
* @see AWS
* API Documentation
*/
default CompletableFuture describeCache(Consumer describeCacheRequest) {
return describeCache(DescribeCacheRequest.builder().applyMutation(describeCacheRequest).build());
}
/**
*
* Returns a description of the gateway volumes specified in the request. This operation is only supported in the
* cached volume gateway types.
*
*
* The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway
* returns volume information sorted by volume Amazon Resource Name (ARN).
*
*
* @param describeCachediScsiVolumesRequest
* @return A Java Future containing the result of the DescribeCachediSCSIVolumes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeCachediSCSIVolumes
* @see AWS API Documentation
*/
default CompletableFuture describeCachediSCSIVolumes(
DescribeCachediScsiVolumesRequest describeCachediScsiVolumesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a description of the gateway volumes specified in the request. This operation is only supported in the
* cached volume gateway types.
*
*
* The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway
* returns volume information sorted by volume Amazon Resource Name (ARN).
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCachediScsiVolumesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeCachediScsiVolumesRequest#builder()}
*
*
* @param describeCachediScsiVolumesRequest
* A {@link Consumer} that will call methods on {@link DescribeCachediSCSIVolumesInput.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeCachediSCSIVolumes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeCachediSCSIVolumes
* @see AWS API Documentation
*/
default CompletableFuture describeCachediSCSIVolumes(
Consumer describeCachediScsiVolumesRequest) {
return describeCachediSCSIVolumes(DescribeCachediScsiVolumesRequest.builder()
.applyMutation(describeCachediScsiVolumesRequest).build());
}
/**
*
* Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified
* iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway
* types.
*
*
* @param describeChapCredentialsRequest
* A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
* @return A Java Future containing the result of the DescribeChapCredentials operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeChapCredentials
* @see AWS API Documentation
*/
default CompletableFuture describeChapCredentials(
DescribeChapCredentialsRequest describeChapCredentialsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified
* iSCSI target, one for each target-initiator pair. This operation is supported in the volume and tape gateway
* types.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeChapCredentialsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeChapCredentialsRequest#builder()}
*
*
* @param describeChapCredentialsRequest
* A {@link Consumer} that will call methods on {@link DescribeChapCredentialsInput.Builder} to create a
* request. A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.
* @return A Java Future containing the result of the DescribeChapCredentials operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeChapCredentials
* @see AWS API Documentation
*/
default CompletableFuture describeChapCredentials(
Consumer describeChapCredentialsRequest) {
return describeChapCredentials(DescribeChapCredentialsRequest.builder().applyMutation(describeChapCredentialsRequest)
.build());
}
/**
*
* Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state
* (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN)
* of the gateway in your request.
*
*
* @param describeGatewayInformationRequest
* A JSON object containing the ID of the gateway.
* @return A Java Future containing the result of the DescribeGatewayInformation operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeGatewayInformation
* @see AWS API Documentation
*/
default CompletableFuture describeGatewayInformation(
DescribeGatewayInformationRequest describeGatewayInformationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state
* (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN)
* of the gateway in your request.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeGatewayInformationRequest.Builder} avoiding
* the need to create one manually via {@link DescribeGatewayInformationRequest#builder()}
*
*
* @param describeGatewayInformationRequest
* A {@link Consumer} that will call methods on {@link DescribeGatewayInformationInput.Builder} to create a
* request. A JSON object containing the ID of the gateway.
* @return A Java Future containing the result of the DescribeGatewayInformation operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeGatewayInformation
* @see AWS API Documentation
*/
default CompletableFuture describeGatewayInformation(
Consumer describeGatewayInformationRequest) {
return describeGatewayInformation(DescribeGatewayInformationRequest.builder()
.applyMutation(describeGatewayInformationRequest).build());
}
/**
*
* Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are
* in terms of the gateway's time zone.
*
*
* @param describeMaintenanceStartTimeRequest
* A JSON object containing the of the gateway.
* @return A Java Future containing the result of the DescribeMaintenanceStartTime operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeMaintenanceStartTime
* @see AWS API Documentation
*/
default CompletableFuture describeMaintenanceStartTime(
DescribeMaintenanceStartTimeRequest describeMaintenanceStartTimeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are
* in terms of the gateway's time zone.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeMaintenanceStartTimeRequest.Builder}
* avoiding the need to create one manually via {@link DescribeMaintenanceStartTimeRequest#builder()}
*
*
* @param describeMaintenanceStartTimeRequest
* A {@link Consumer} that will call methods on {@link DescribeMaintenanceStartTimeInput.Builder} to create a
* request. A JSON object containing the of the gateway.
* @return A Java Future containing the result of the DescribeMaintenanceStartTime operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeMaintenanceStartTime
* @see AWS API Documentation
*/
default CompletableFuture describeMaintenanceStartTime(
Consumer describeMaintenanceStartTimeRequest) {
return describeMaintenanceStartTime(DescribeMaintenanceStartTimeRequest.builder()
.applyMutation(describeMaintenanceStartTimeRequest).build());
}
/**
*
* Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is
* only supported for file gateways.
*
*
* @param describeNfsFileSharesRequest
* DescribeNFSFileSharesInput
* @return A Java Future containing the result of the DescribeNFSFileShares operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeNFSFileShares
* @see AWS API Documentation
*/
default CompletableFuture describeNFSFileShares(
DescribeNfsFileSharesRequest describeNfsFileSharesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is
* only supported for file gateways.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeNfsFileSharesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeNfsFileSharesRequest#builder()}
*
*
* @param describeNfsFileSharesRequest
* A {@link Consumer} that will call methods on {@link DescribeNFSFileSharesInput.Builder} to create a
* request. DescribeNFSFileSharesInput
* @return A Java Future containing the result of the DescribeNFSFileShares operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeNFSFileShares
* @see AWS API Documentation
*/
default CompletableFuture describeNFSFileShares(
Consumer describeNfsFileSharesRequest) {
return describeNFSFileShares(DescribeNfsFileSharesRequest.builder().applyMutation(describeNfsFileSharesRequest).build());
}
/**
*
* Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is
* only supported for file gateways.
*
*
* @param describeSmbFileSharesRequest
* DescribeSMBFileSharesInput
* @return A Java Future containing the result of the DescribeSMBFileShares operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeSMBFileShares
* @see AWS API Documentation
*/
default CompletableFuture describeSMBFileShares(
DescribeSmbFileSharesRequest describeSmbFileSharesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is
* only supported for file gateways.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSmbFileSharesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeSmbFileSharesRequest#builder()}
*
*
* @param describeSmbFileSharesRequest
* A {@link Consumer} that will call methods on {@link DescribeSMBFileSharesInput.Builder} to create a
* request. DescribeSMBFileSharesInput
* @return A Java Future containing the result of the DescribeSMBFileShares operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeSMBFileShares
* @see AWS API Documentation
*/
default CompletableFuture describeSMBFileShares(
Consumer describeSmbFileSharesRequest) {
return describeSMBFileShares(DescribeSmbFileSharesRequest.builder().applyMutation(describeSmbFileSharesRequest).build());
}
/**
*
* Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is
* only supported for file gateways.
*
*
* @param describeSmbSettingsRequest
* @return A Java Future containing the result of the DescribeSMBSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeSMBSettings
* @see AWS API Documentation
*/
default CompletableFuture describeSMBSettings(
DescribeSmbSettingsRequest describeSmbSettingsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is
* only supported for file gateways.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSmbSettingsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeSmbSettingsRequest#builder()}
*
*
* @param describeSmbSettingsRequest
* A {@link Consumer} that will call methods on {@link DescribeSMBSettingsInput.Builder} to create a request.
* @return A Java Future containing the result of the DescribeSMBSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeSMBSettings
* @see AWS API Documentation
*/
default CompletableFuture describeSMBSettings(
Consumer describeSmbSettingsRequest) {
return describeSMBSettings(DescribeSmbSettingsRequest.builder().applyMutation(describeSmbSettingsRequest).build());
}
/**
*
* Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes
* intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the
* cached volume and stored volume types.
*
*
* @param describeSnapshotScheduleRequest
* A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
* @return A Java Future containing the result of the DescribeSnapshotSchedule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeSnapshotSchedule
* @see AWS API Documentation
*/
default CompletableFuture describeSnapshotSchedule(
DescribeSnapshotScheduleRequest describeSnapshotScheduleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes
* intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the
* cached volume and stored volume types.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSnapshotScheduleRequest.Builder} avoiding
* the need to create one manually via {@link DescribeSnapshotScheduleRequest#builder()}
*
*
* @param describeSnapshotScheduleRequest
* A {@link Consumer} that will call methods on {@link DescribeSnapshotScheduleInput.Builder} to create a
* request. A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.
* @return A Java Future containing the result of the DescribeSnapshotSchedule operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeSnapshotSchedule
* @see AWS API Documentation
*/
default CompletableFuture describeSnapshotSchedule(
Consumer describeSnapshotScheduleRequest) {
return describeSnapshotSchedule(DescribeSnapshotScheduleRequest.builder().applyMutation(describeSnapshotScheduleRequest)
.build());
}
/**
*
* Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the
* request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by
* volume ARNs. This operation is only supported in stored volume gateway type.
*
*
* @param describeStorediScsiVolumesRequest
* A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
* @return A Java Future containing the result of the DescribeStorediSCSIVolumes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeStorediSCSIVolumes
* @see AWS API Documentation
*/
default CompletableFuture describeStorediSCSIVolumes(
DescribeStorediScsiVolumesRequest describeStorediScsiVolumesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the
* request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by
* volume ARNs. This operation is only supported in stored volume gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStorediScsiVolumesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeStorediScsiVolumesRequest#builder()}
*
*
* @param describeStorediScsiVolumesRequest
* A {@link Consumer} that will call methods on {@link DescribeStorediSCSIVolumesInput.Builder} to create a
* request. A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.
* @return A Java Future containing the result of the DescribeStorediSCSIVolumes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeStorediSCSIVolumes
* @see AWS API Documentation
*/
default CompletableFuture describeStorediSCSIVolumes(
Consumer describeStorediScsiVolumesRequest) {
return describeStorediSCSIVolumes(DescribeStorediScsiVolumesRequest.builder()
.applyMutation(describeStorediScsiVolumesRequest).build());
}
/**
*
* Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only
* supported in the tape gateway type.
*
*
* If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual
* tapes found in the VTS associated with your account.
*
*
* @param describeTapeArchivesRequest
* DescribeTapeArchivesInput
* @return A Java Future containing the result of the DescribeTapeArchives operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeArchives
* @see AWS API Documentation
*/
default CompletableFuture describeTapeArchives(
DescribeTapeArchivesRequest describeTapeArchivesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only
* supported in the tape gateway type.
*
*
* If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual
* tapes found in the VTS associated with your account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeTapeArchivesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeTapeArchivesRequest#builder()}
*
*
* @param describeTapeArchivesRequest
* A {@link Consumer} that will call methods on {@link DescribeTapeArchivesInput.Builder} to create a
* request. DescribeTapeArchivesInput
* @return A Java Future containing the result of the DescribeTapeArchives operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeArchives
* @see AWS API Documentation
*/
default CompletableFuture describeTapeArchives(
Consumer describeTapeArchivesRequest) {
return describeTapeArchives(DescribeTapeArchivesRequest.builder().applyMutation(describeTapeArchivesRequest).build());
}
/**
*
* Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only
* supported in the tape gateway type.
*
*
* If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual
* tapes found in the VTS associated with your account.
*
*
* @return A Java Future containing the result of the DescribeTapeArchives operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeArchives
* @see AWS API Documentation
*/
default CompletableFuture describeTapeArchives() {
return describeTapeArchives(DescribeTapeArchivesRequest.builder().build());
}
/**
*
* Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only
* supported in the tape gateway type.
*
*
* If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual
* tapes found in the VTS associated with your account.
*
*
*
* This is a variant of
* {@link #describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher publisher = client.describeTapeArchivesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher publisher = client.describeTapeArchivesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeArchives
* @see AWS API Documentation
*/
default DescribeTapeArchivesPublisher describeTapeArchivesPaginator() {
return describeTapeArchivesPaginator(DescribeTapeArchivesRequest.builder().build());
}
/**
*
* Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only
* supported in the tape gateway type.
*
*
* If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual
* tapes found in the VTS associated with your account.
*
*
*
* This is a variant of
* {@link #describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher publisher = client.describeTapeArchivesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher publisher = client.describeTapeArchivesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)}
* operation.
*
*
* @param describeTapeArchivesRequest
* DescribeTapeArchivesInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeArchives
* @see AWS API Documentation
*/
default DescribeTapeArchivesPublisher describeTapeArchivesPaginator(DescribeTapeArchivesRequest describeTapeArchivesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only
* supported in the tape gateway type.
*
*
* If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual
* tapes found in the VTS associated with your account.
*
*
*
* This is a variant of
* {@link #describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher publisher = client.describeTapeArchivesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher publisher = client.describeTapeArchivesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeTapeArchivesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeTapeArchivesRequest#builder()}
*
*
* @param describeTapeArchivesRequest
* A {@link Consumer} that will call methods on {@link DescribeTapeArchivesInput.Builder} to create a
* request. DescribeTapeArchivesInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeArchives
* @see AWS API Documentation
*/
default DescribeTapeArchivesPublisher describeTapeArchivesPaginator(
Consumer describeTapeArchivesRequest) {
return describeTapeArchivesPaginator(DescribeTapeArchivesRequest.builder().applyMutation(describeTapeArchivesRequest)
.build());
}
/**
*
* Returns a list of virtual tape recovery points that are available for the specified tape gateway.
*
*
* A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is
* consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
* This operation is only supported in the tape gateway type.
*
*
* @param describeTapeRecoveryPointsRequest
* DescribeTapeRecoveryPointsInput
* @return A Java Future containing the result of the DescribeTapeRecoveryPoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeRecoveryPoints
* @see AWS API Documentation
*/
default CompletableFuture describeTapeRecoveryPoints(
DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of virtual tape recovery points that are available for the specified tape gateway.
*
*
* A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is
* consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
* This operation is only supported in the tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeTapeRecoveryPointsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeTapeRecoveryPointsRequest#builder()}
*
*
* @param describeTapeRecoveryPointsRequest
* A {@link Consumer} that will call methods on {@link DescribeTapeRecoveryPointsInput.Builder} to create a
* request. DescribeTapeRecoveryPointsInput
* @return A Java Future containing the result of the DescribeTapeRecoveryPoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeRecoveryPoints
* @see AWS API Documentation
*/
default CompletableFuture describeTapeRecoveryPoints(
Consumer describeTapeRecoveryPointsRequest) {
return describeTapeRecoveryPoints(DescribeTapeRecoveryPointsRequest.builder()
.applyMutation(describeTapeRecoveryPointsRequest).build());
}
/**
*
* Returns a list of virtual tape recovery points that are available for the specified tape gateway.
*
*
* A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is
* consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
* This operation is only supported in the tape gateway type.
*
*
*
* This is a variant of
* {@link #describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsPublisher publisher = client.describeTapeRecoveryPointsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsPublisher publisher = client.describeTapeRecoveryPointsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)}
* operation.
*
*
* @param describeTapeRecoveryPointsRequest
* DescribeTapeRecoveryPointsInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeRecoveryPoints
* @see AWS API Documentation
*/
default DescribeTapeRecoveryPointsPublisher describeTapeRecoveryPointsPaginator(
DescribeTapeRecoveryPointsRequest describeTapeRecoveryPointsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of virtual tape recovery points that are available for the specified tape gateway.
*
*
* A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is
* consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
* This operation is only supported in the tape gateway type.
*
*
*
* This is a variant of
* {@link #describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsPublisher publisher = client.describeTapeRecoveryPointsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeRecoveryPointsPublisher publisher = client.describeTapeRecoveryPointsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeTapeRecoveryPoints(software.amazon.awssdk.services.storagegateway.model.DescribeTapeRecoveryPointsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeTapeRecoveryPointsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeTapeRecoveryPointsRequest#builder()}
*
*
* @param describeTapeRecoveryPointsRequest
* A {@link Consumer} that will call methods on {@link DescribeTapeRecoveryPointsInput.Builder} to create a
* request. DescribeTapeRecoveryPointsInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapeRecoveryPoints
* @see AWS API Documentation
*/
default DescribeTapeRecoveryPointsPublisher describeTapeRecoveryPointsPaginator(
Consumer describeTapeRecoveryPointsRequest) {
return describeTapeRecoveryPointsPaginator(DescribeTapeRecoveryPointsRequest.builder()
.applyMutation(describeTapeRecoveryPointsRequest).build());
}
/**
*
* Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is
* not specified, returns a description of all virtual tapes associated with the specified gateway. This operation
* is only supported in the tape gateway type.
*
*
* @param describeTapesRequest
* DescribeTapesInput
* @return A Java Future containing the result of the DescribeTapes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapes
* @see AWS
* API Documentation
*/
default CompletableFuture describeTapes(DescribeTapesRequest describeTapesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is
* not specified, returns a description of all virtual tapes associated with the specified gateway. This operation
* is only supported in the tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeTapesRequest.Builder} avoiding the need to
* create one manually via {@link DescribeTapesRequest#builder()}
*
*
* @param describeTapesRequest
* A {@link Consumer} that will call methods on {@link DescribeTapesInput.Builder} to create a request.
* DescribeTapesInput
* @return A Java Future containing the result of the DescribeTapes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapes
* @see AWS
* API Documentation
*/
default CompletableFuture describeTapes(Consumer describeTapesRequest) {
return describeTapes(DescribeTapesRequest.builder().applyMutation(describeTapesRequest).build());
}
/**
*
* Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is
* not specified, returns a description of all virtual tapes associated with the specified gateway. This operation
* is only supported in the tape gateway type.
*
*
*
* This is a variant of
* {@link #describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesPublisher publisher = client.describeTapesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesPublisher publisher = client.describeTapesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeTapesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest)} operation.
*
*
* @param describeTapesRequest
* DescribeTapesInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapes
* @see AWS
* API Documentation
*/
default DescribeTapesPublisher describeTapesPaginator(DescribeTapesRequest describeTapesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is
* not specified, returns a description of all virtual tapes associated with the specified gateway. This operation
* is only supported in the tape gateway type.
*
*
*
* This is a variant of
* {@link #describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesPublisher publisher = client.describeTapesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeTapesPublisher publisher = client.describeTapesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeTapesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeTapes(software.amazon.awssdk.services.storagegateway.model.DescribeTapesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeTapesRequest.Builder} avoiding the need to
* create one manually via {@link DescribeTapesRequest#builder()}
*
*
* @param describeTapesRequest
* A {@link Consumer} that will call methods on {@link DescribeTapesInput.Builder} to create a request.
* DescribeTapesInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeTapes
* @see AWS
* API Documentation
*/
default DescribeTapesPublisher describeTapesPaginator(Consumer describeTapesRequest) {
return describeTapesPaginator(DescribeTapesRequest.builder().applyMutation(describeTapesRequest).build());
}
/**
*
* Returns information about the upload buffer of a gateway. This operation is supported for the stored volume,
* cached volume and tape gateway types.
*
*
* The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload
* buffer space allocated and used.
*
*
* @param describeUploadBufferRequest
* @return A Java Future containing the result of the DescribeUploadBuffer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeUploadBuffer
* @see AWS API Documentation
*/
default CompletableFuture describeUploadBuffer(
DescribeUploadBufferRequest describeUploadBufferRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about the upload buffer of a gateway. This operation is supported for the stored volume,
* cached volume and tape gateway types.
*
*
* The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload
* buffer space allocated and used.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeUploadBufferRequest.Builder} avoiding the
* need to create one manually via {@link DescribeUploadBufferRequest#builder()}
*
*
* @param describeUploadBufferRequest
* A {@link Consumer} that will call methods on {@link DescribeUploadBufferInput.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeUploadBuffer operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeUploadBuffer
* @see AWS API Documentation
*/
default CompletableFuture describeUploadBuffer(
Consumer describeUploadBufferRequest) {
return describeUploadBuffer(DescribeUploadBufferRequest.builder().applyMutation(describeUploadBufferRequest).build());
}
/**
*
* Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS
* Storage Gateway returns VTL device information.
*
*
* This operation is only supported in the tape gateway type.
*
*
* @param describeVtlDevicesRequest
* DescribeVTLDevicesInput
* @return A Java Future containing the result of the DescribeVTLDevices operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeVTLDevices
* @see AWS API Documentation
*/
default CompletableFuture describeVTLDevices(DescribeVtlDevicesRequest describeVtlDevicesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS
* Storage Gateway returns VTL device information.
*
*
* This operation is only supported in the tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeVtlDevicesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeVtlDevicesRequest#builder()}
*
*
* @param describeVtlDevicesRequest
* A {@link Consumer} that will call methods on {@link DescribeVTLDevicesInput.Builder} to create a request.
* DescribeVTLDevicesInput
* @return A Java Future containing the result of the DescribeVTLDevices operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeVTLDevices
* @see AWS API Documentation
*/
default CompletableFuture describeVTLDevices(
Consumer describeVtlDevicesRequest) {
return describeVTLDevices(DescribeVtlDevicesRequest.builder().applyMutation(describeVtlDevicesRequest).build());
}
/**
*
* Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS
* Storage Gateway returns VTL device information.
*
*
* This operation is only supported in the tape gateway type.
*
*
*
* This is a variant of
* {@link #describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesPublisher publisher = client.describeVTLDevicesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesPublisher publisher = client.describeVTLDevicesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)}
* operation.
*
*
* @param describeVtlDevicesRequest
* DescribeVTLDevicesInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeVTLDevices
* @see AWS API Documentation
*/
default DescribeVTLDevicesPublisher describeVTLDevicesPaginator(DescribeVtlDevicesRequest describeVtlDevicesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS
* Storage Gateway returns VTL device information.
*
*
* This operation is only supported in the tape gateway type.
*
*
*
* This is a variant of
* {@link #describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesPublisher publisher = client.describeVTLDevicesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.DescribeVTLDevicesPublisher publisher = client.describeVTLDevicesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeVTLDevices(software.amazon.awssdk.services.storagegateway.model.DescribeVtlDevicesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeVtlDevicesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeVtlDevicesRequest#builder()}
*
*
* @param describeVtlDevicesRequest
* A {@link Consumer} that will call methods on {@link DescribeVTLDevicesInput.Builder} to create a request.
* DescribeVTLDevicesInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeVTLDevices
* @see AWS API Documentation
*/
default DescribeVTLDevicesPublisher describeVTLDevicesPaginator(
Consumer describeVtlDevicesRequest) {
return describeVTLDevicesPaginator(DescribeVtlDevicesRequest.builder().applyMutation(describeVtlDevicesRequest).build());
}
/**
*
* Returns information about the working storage of a gateway. This operation is only supported in the stored
* volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use
* DescribeUploadBuffer instead.
*
*
*
* Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add
* upload buffer to a stored volume gateway.
*
*
*
* The response includes disk IDs that are configured as working storage, and it includes the amount of working
* storage allocated and used.
*
*
* @param describeWorkingStorageRequest
* A JSON object containing the of the gateway.
* @return A Java Future containing the result of the DescribeWorkingStorage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeWorkingStorage
* @see AWS API Documentation
*/
default CompletableFuture describeWorkingStorage(
DescribeWorkingStorageRequest describeWorkingStorageRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about the working storage of a gateway. This operation is only supported in the stored
* volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use
* DescribeUploadBuffer instead.
*
*
*
* Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add
* upload buffer to a stored volume gateway.
*
*
*
* The response includes disk IDs that are configured as working storage, and it includes the amount of working
* storage allocated and used.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeWorkingStorageRequest.Builder} avoiding the
* need to create one manually via {@link DescribeWorkingStorageRequest#builder()}
*
*
* @param describeWorkingStorageRequest
* A {@link Consumer} that will call methods on {@link DescribeWorkingStorageInput.Builder} to create a
* request. A JSON object containing the of the gateway.
* @return A Java Future containing the result of the DescribeWorkingStorage operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DescribeWorkingStorage
* @see AWS API Documentation
*/
default CompletableFuture describeWorkingStorage(
Consumer describeWorkingStorageRequest) {
return describeWorkingStorage(DescribeWorkingStorageRequest.builder().applyMutation(describeWorkingStorageRequest)
.build());
}
/**
*
* Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching
* and attaching a volume enables you to recover your data from one gateway to a different gateway without creating
* a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an
* Amazon EC2 instance. This operation is only supported in the volume gateway type.
*
*
* @param detachVolumeRequest
* AttachVolumeInput
* @return A Java Future containing the result of the DetachVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DetachVolume
* @see AWS
* API Documentation
*/
default CompletableFuture detachVolume(DetachVolumeRequest detachVolumeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching
* and attaching a volume enables you to recover your data from one gateway to a different gateway without creating
* a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an
* Amazon EC2 instance. This operation is only supported in the volume gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link DetachVolumeRequest.Builder} avoiding the need to
* create one manually via {@link DetachVolumeRequest#builder()}
*
*
* @param detachVolumeRequest
* A {@link Consumer} that will call methods on {@link DetachVolumeInput.Builder} to create a request.
* AttachVolumeInput
* @return A Java Future containing the result of the DetachVolume operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DetachVolume
* @see AWS
* API Documentation
*/
default CompletableFuture detachVolume(Consumer detachVolumeRequest) {
return detachVolume(DetachVolumeRequest.builder().applyMutation(detachVolumeRequest).build());
}
/**
*
* Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged,
* you can disable the gateway so you can recover virtual tapes.
*
*
* Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported
* in the tape gateway type.
*
*
*
* Once a gateway is disabled it cannot be enabled.
*
*
*
* @param disableGatewayRequest
* DisableGatewayInput
* @return A Java Future containing the result of the DisableGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DisableGateway
* @see AWS
* API Documentation
*/
default CompletableFuture disableGateway(DisableGatewayRequest disableGatewayRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged,
* you can disable the gateway so you can recover virtual tapes.
*
*
* Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported
* in the tape gateway type.
*
*
*
* Once a gateway is disabled it cannot be enabled.
*
*
*
* This is a convenience which creates an instance of the {@link DisableGatewayRequest.Builder} avoiding the need to
* create one manually via {@link DisableGatewayRequest#builder()}
*
*
* @param disableGatewayRequest
* A {@link Consumer} that will call methods on {@link DisableGatewayInput.Builder} to create a request.
* DisableGatewayInput
* @return A Java Future containing the result of the DisableGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.DisableGateway
* @see AWS
* API Documentation
*/
default CompletableFuture disableGateway(Consumer disableGatewayRequest) {
return disableGateway(DisableGatewayRequest.builder().applyMutation(disableGatewayRequest).build());
}
/**
*
* Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that
* support the SMB file protocol.
*
*
* @param joinDomainRequest
* JoinDomainInput
* @return A Java Future containing the result of the JoinDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.JoinDomain
* @see AWS API
* Documentation
*/
default CompletableFuture joinDomain(JoinDomainRequest joinDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that
* support the SMB file protocol.
*
*
*
* This is a convenience which creates an instance of the {@link JoinDomainRequest.Builder} avoiding the need to
* create one manually via {@link JoinDomainRequest#builder()}
*
*
* @param joinDomainRequest
* A {@link Consumer} that will call methods on {@link JoinDomainInput.Builder} to create a request.
* JoinDomainInput
* @return A Java Future containing the result of the JoinDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.JoinDomain
* @see AWS API
* Documentation
*/
default CompletableFuture joinDomain(Consumer joinDomainRequest) {
return joinDomain(JoinDomainRequest.builder().applyMutation(joinDomainRequest).build());
}
/**
*
* Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
* user account. This operation is only supported for file gateways.
*
*
* @param listFileSharesRequest
* ListFileShareInput
* @return A Java Future containing the result of the ListFileShares operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListFileShares
* @see AWS
* API Documentation
*/
default CompletableFuture listFileShares(ListFileSharesRequest listFileSharesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
* user account. This operation is only supported for file gateways.
*
*
*
* This is a convenience which creates an instance of the {@link ListFileSharesRequest.Builder} avoiding the need to
* create one manually via {@link ListFileSharesRequest#builder()}
*
*
* @param listFileSharesRequest
* A {@link Consumer} that will call methods on {@link ListFileSharesInput.Builder} to create a request.
* ListFileShareInput
* @return A Java Future containing the result of the ListFileShares operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListFileShares
* @see AWS
* API Documentation
*/
default CompletableFuture listFileShares(Consumer listFileSharesRequest) {
return listFileShares(ListFileSharesRequest.builder().applyMutation(listFileSharesRequest).build());
}
/**
*
* Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
* user account. This operation is only supported for file gateways.
*
*
* @return A Java Future containing the result of the ListFileShares operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListFileShares
* @see AWS
* API Documentation
*/
default CompletableFuture listFileShares() {
return listFileShares(ListFileSharesRequest.builder().build());
}
/**
*
* Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
* user account. This operation is only supported for file gateways.
*
*
*
* This is a variant of
* {@link #listFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListFileSharesPublisher publisher = client.listFileSharesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListFileSharesPublisher publisher = client.listFileSharesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListFileSharesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListFileShares
* @see AWS
* API Documentation
*/
default ListFileSharesPublisher listFileSharesPaginator() {
return listFileSharesPaginator(ListFileSharesRequest.builder().build());
}
/**
*
* Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
* user account. This operation is only supported for file gateways.
*
*
*
* This is a variant of
* {@link #listFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListFileSharesPublisher publisher = client.listFileSharesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListFileSharesPublisher publisher = client.listFileSharesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListFileSharesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)}
* operation.
*
*
* @param listFileSharesRequest
* ListFileShareInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListFileShares
* @see AWS
* API Documentation
*/
default ListFileSharesPublisher listFileSharesPaginator(ListFileSharesRequest listFileSharesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling
* user account. This operation is only supported for file gateways.
*
*
*
* This is a variant of
* {@link #listFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListFileSharesPublisher publisher = client.listFileSharesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListFileSharesPublisher publisher = client.listFileSharesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListFileSharesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listFileShares(software.amazon.awssdk.services.storagegateway.model.ListFileSharesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListFileSharesRequest.Builder} avoiding the need to
* create one manually via {@link ListFileSharesRequest#builder()}
*
*
* @param listFileSharesRequest
* A {@link Consumer} that will call methods on {@link ListFileSharesInput.Builder} to create a request.
* ListFileShareInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListFileShares
* @see AWS
* API Documentation
*/
default ListFileSharesPublisher listFileSharesPaginator(Consumer listFileSharesRequest) {
return listFileSharesPaginator(ListFileSharesRequest.builder().applyMutation(listFileSharesRequest).build());
}
/**
*
* Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by
* gateway Amazon Resource Name (ARN).
*
*
* By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you
* to optionally reduce the number of gateways returned in a response.
*
*
* If you have more gateways than are returned in a response (that is, the response returns only a truncated list of
* your gateways), the response contains a marker that you can specify in your next request to fetch the next page
* of gateways.
*
*
* @param listGatewaysRequest
* A JSON object containing zero or more of the following fields:
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the ListGateways operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListGateways
* @see AWS
* API Documentation
*/
default CompletableFuture listGateways(ListGatewaysRequest listGatewaysRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by
* gateway Amazon Resource Name (ARN).
*
*
* By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you
* to optionally reduce the number of gateways returned in a response.
*
*
* If you have more gateways than are returned in a response (that is, the response returns only a truncated list of
* your gateways), the response contains a marker that you can specify in your next request to fetch the next page
* of gateways.
*
*
*
* This is a convenience which creates an instance of the {@link ListGatewaysRequest.Builder} avoiding the need to
* create one manually via {@link ListGatewaysRequest#builder()}
*
*
* @param listGatewaysRequest
* A {@link Consumer} that will call methods on {@link ListGatewaysInput.Builder} to create a request. A JSON
* object containing zero or more of the following fields:
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the ListGateways operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListGateways
* @see AWS
* API Documentation
*/
default CompletableFuture listGateways(Consumer listGatewaysRequest) {
return listGateways(ListGatewaysRequest.builder().applyMutation(listGatewaysRequest).build());
}
/**
*
* Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by
* gateway Amazon Resource Name (ARN).
*
*
* By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you
* to optionally reduce the number of gateways returned in a response.
*
*
* If you have more gateways than are returned in a response (that is, the response returns only a truncated list of
* your gateways), the response contains a marker that you can specify in your next request to fetch the next page
* of gateways.
*
*
* @return A Java Future containing the result of the ListGateways operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListGateways
* @see AWS
* API Documentation
*/
default CompletableFuture listGateways() {
return listGateways(ListGatewaysRequest.builder().build());
}
/**
*
* Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by
* gateway Amazon Resource Name (ARN).
*
*
* By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you
* to optionally reduce the number of gateways returned in a response.
*
*
* If you have more gateways than are returned in a response (that is, the response returns only a truncated list of
* your gateways), the response contains a marker that you can specify in your next request to fetch the next page
* of gateways.
*
*
*
* This is a variant of
* {@link #listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListGatewaysResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListGateways
* @see AWS
* API Documentation
*/
default ListGatewaysPublisher listGatewaysPaginator() {
return listGatewaysPaginator(ListGatewaysRequest.builder().build());
}
/**
*
* Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by
* gateway Amazon Resource Name (ARN).
*
*
* By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you
* to optionally reduce the number of gateways returned in a response.
*
*
* If you have more gateways than are returned in a response (that is, the response returns only a truncated list of
* your gateways), the response contains a marker that you can specify in your next request to fetch the next page
* of gateways.
*
*
*
* This is a variant of
* {@link #listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListGatewaysResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)} operation.
*
*
* @param listGatewaysRequest
* A JSON object containing zero or more of the following fields:
*
* -
*
*
* -
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListGateways
* @see AWS
* API Documentation
*/
default ListGatewaysPublisher listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by
* gateway Amazon Resource Name (ARN).
*
*
* By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you
* to optionally reduce the number of gateways returned in a response.
*
*
* If you have more gateways than are returned in a response (that is, the response returns only a truncated list of
* your gateways), the response contains a marker that you can specify in your next request to fetch the next page
* of gateways.
*
*
*
* This is a variant of
* {@link #listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListGatewaysPublisher publisher = client.listGatewaysPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListGatewaysResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listGateways(software.amazon.awssdk.services.storagegateway.model.ListGatewaysRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListGatewaysRequest.Builder} avoiding the need to
* create one manually via {@link ListGatewaysRequest#builder()}
*
*
* @param listGatewaysRequest
* A {@link Consumer} that will call methods on {@link ListGatewaysInput.Builder} to create a request. A JSON
* object containing zero or more of the following fields:
*
* -
*
*
* -
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListGateways
* @see AWS
* API Documentation
*/
default ListGatewaysPublisher listGatewaysPaginator(Consumer listGatewaysRequest) {
return listGatewaysPaginator(ListGatewaysRequest.builder().applyMutation(listGatewaysRequest).build());
}
/**
*
* Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource
* Name (ARN) of the gateway in the body of the request.
*
*
* The request returns a list of all disks, specifying which are configured as working storage, cache storage, or
* stored volume or not configured at all. The response includes a DiskStatus field. This field can
* have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway),
* or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
*
*
* @param listLocalDisksRequest
* A JSON object containing the of the gateway.
* @return A Java Future containing the result of the ListLocalDisks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListLocalDisks
* @see AWS
* API Documentation
*/
default CompletableFuture listLocalDisks(ListLocalDisksRequest listLocalDisksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource
* Name (ARN) of the gateway in the body of the request.
*
*
* The request returns a list of all disks, specifying which are configured as working storage, cache storage, or
* stored volume or not configured at all. The response includes a DiskStatus field. This field can
* have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway),
* or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).
*
*
*
* This is a convenience which creates an instance of the {@link ListLocalDisksRequest.Builder} avoiding the need to
* create one manually via {@link ListLocalDisksRequest#builder()}
*
*
* @param listLocalDisksRequest
* A {@link Consumer} that will call methods on {@link ListLocalDisksInput.Builder} to create a request. A
* JSON object containing the of the gateway.
* @return A Java Future containing the result of the ListLocalDisks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListLocalDisks
* @see AWS
* API Documentation
*/
default CompletableFuture listLocalDisks(Consumer listLocalDisksRequest) {
return listLocalDisks(ListLocalDisksRequest.builder().applyMutation(listLocalDisksRequest).build());
}
/**
*
* Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of
* all types.
*
*
* @param listTagsForResourceRequest
* ListTagsForResourceInput
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of
* all types.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceInput.Builder} to create a request.
* ListTagsForResourceInput
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of
* all types.
*
*
*
* This is a variant of
* {@link #listTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)}
* operation.
*
*
* @param listTagsForResourceRequest
* ListTagsForResourceInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the tags that have been added to the specified resource. This operation is supported in storage gateways of
* all types.
*
*
*
* This is a variant of
* {@link #listTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listTagsForResource(software.amazon.awssdk.services.storagegateway.model.ListTagsForResourceRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceInput.Builder} to create a request.
* ListTagsForResourceInput
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourcePublisher listTagsForResourcePaginator(
Consumer listTagsForResourceRequest) {
return listTagsForResourcePaginator(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest)
.build());
}
/**
*
* Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes
* to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the
* operation lists all virtual tapes in both your VTL and VTS.
*
*
* This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can
* optionally specify the Limit parameter in the body to limit the number of tapes in the response. If
* the number of tapes returned in the response is truncated, the response includes a Marker element
* that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported
* in the tape gateway type.
*
*
* @param listTapesRequest
* A JSON object that contains one or more of the following fields:
*
* -
*
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the ListTapes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTapes
* @see AWS API
* Documentation
*/
default CompletableFuture listTapes(ListTapesRequest listTapesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes
* to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the
* operation lists all virtual tapes in both your VTL and VTS.
*
*
* This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can
* optionally specify the Limit parameter in the body to limit the number of tapes in the response. If
* the number of tapes returned in the response is truncated, the response includes a Marker element
* that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported
* in the tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link ListTapesRequest.Builder} avoiding the need to
* create one manually via {@link ListTapesRequest#builder()}
*
*
* @param listTapesRequest
* A {@link Consumer} that will call methods on {@link ListTapesInput.Builder} to create a request. A JSON
* object that contains one or more of the following fields:
*
* -
*
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the ListTapes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTapes
* @see AWS API
* Documentation
*/
default CompletableFuture listTapes(Consumer listTapesRequest) {
return listTapes(ListTapesRequest.builder().applyMutation(listTapesRequest).build());
}
/**
*
* Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes
* to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the
* operation lists all virtual tapes in both your VTL and VTS.
*
*
* This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can
* optionally specify the Limit parameter in the body to limit the number of tapes in the response. If
* the number of tapes returned in the response is truncated, the response includes a Marker element
* that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported
* in the tape gateway type.
*
*
* @return A Java Future containing the result of the ListTapes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTapes
* @see AWS API
* Documentation
*/
default CompletableFuture listTapes() {
return listTapes(ListTapesRequest.builder().build());
}
/**
*
* Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes
* to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the
* operation lists all virtual tapes in both your VTL and VTS.
*
*
* This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can
* optionally specify the Limit parameter in the body to limit the number of tapes in the response. If
* the number of tapes returned in the response is truncated, the response includes a Marker element
* that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported
* in the tape gateway type.
*
*
*
* This is a variant of {@link #listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTapesPublisher publisher = client.listTapesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTapesPublisher publisher = client.listTapesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListTapesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTapes
* @see AWS API
* Documentation
*/
default ListTapesPublisher listTapesPaginator() {
return listTapesPaginator(ListTapesRequest.builder().build());
}
/**
*
* Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes
* to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the
* operation lists all virtual tapes in both your VTL and VTS.
*
*
* This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can
* optionally specify the Limit parameter in the body to limit the number of tapes in the response. If
* the number of tapes returned in the response is truncated, the response includes a Marker element
* that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported
* in the tape gateway type.
*
*
*
* This is a variant of {@link #listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTapesPublisher publisher = client.listTapesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTapesPublisher publisher = client.listTapesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListTapesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)} operation.
*
*
* @param listTapesRequest
* A JSON object that contains one or more of the following fields:
*
* -
*
*
* -
*
*
* -
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTapes
* @see AWS API
* Documentation
*/
default ListTapesPublisher listTapesPaginator(ListTapesRequest listTapesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes
* to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the
* operation lists all virtual tapes in both your VTL and VTS.
*
*
* This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can
* optionally specify the Limit parameter in the body to limit the number of tapes in the response. If
* the number of tapes returned in the response is truncated, the response includes a Marker element
* that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported
* in the tape gateway type.
*
*
*
* This is a variant of {@link #listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTapesPublisher publisher = client.listTapesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListTapesPublisher publisher = client.listTapesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListTapesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listTapes(software.amazon.awssdk.services.storagegateway.model.ListTapesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListTapesRequest.Builder} avoiding the need to
* create one manually via {@link ListTapesRequest#builder()}
*
*
* @param listTapesRequest
* A {@link Consumer} that will call methods on {@link ListTapesInput.Builder} to create a request. A JSON
* object that contains one or more of the following fields:
*
* -
*
*
* -
*
*
* -
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListTapes
* @see AWS API
* Documentation
*/
default ListTapesPublisher listTapesPaginator(Consumer listTapesRequest) {
return listTapesPaginator(ListTapesRequest.builder().applyMutation(listTapesRequest).build());
}
/**
*
* Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume
* is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
*
*
* @param listVolumeInitiatorsRequest
* ListVolumeInitiatorsInput
* @return A Java Future containing the result of the ListVolumeInitiators operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumeInitiators
* @see AWS API Documentation
*/
default CompletableFuture listVolumeInitiators(
ListVolumeInitiatorsRequest listVolumeInitiatorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume
* is being used or not. This operation is only supported in the cached volume and stored volume gateway types.
*
*
*
* This is a convenience which creates an instance of the {@link ListVolumeInitiatorsRequest.Builder} avoiding the
* need to create one manually via {@link ListVolumeInitiatorsRequest#builder()}
*
*
* @param listVolumeInitiatorsRequest
* A {@link Consumer} that will call methods on {@link ListVolumeInitiatorsInput.Builder} to create a
* request. ListVolumeInitiatorsInput
* @return A Java Future containing the result of the ListVolumeInitiators operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumeInitiators
* @see AWS API Documentation
*/
default CompletableFuture listVolumeInitiators(
Consumer listVolumeInitiatorsRequest) {
return listVolumeInitiators(ListVolumeInitiatorsRequest.builder().applyMutation(listVolumeInitiatorsRequest).build());
}
/**
*
* Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway
* type.
*
*
* Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the
* volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume.
* To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
*
*
* @param listVolumeRecoveryPointsRequest
* @return A Java Future containing the result of the ListVolumeRecoveryPoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumeRecoveryPoints
* @see AWS API Documentation
*/
default CompletableFuture listVolumeRecoveryPoints(
ListVolumeRecoveryPointsRequest listVolumeRecoveryPointsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway
* type.
*
*
* Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the
* volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume.
* To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListVolumeRecoveryPointsRequest.Builder} avoiding
* the need to create one manually via {@link ListVolumeRecoveryPointsRequest#builder()}
*
*
* @param listVolumeRecoveryPointsRequest
* A {@link Consumer} that will call methods on {@link ListVolumeRecoveryPointsInput.Builder} to create a
* request.
* @return A Java Future containing the result of the ListVolumeRecoveryPoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumeRecoveryPoints
* @see AWS API Documentation
*/
default CompletableFuture listVolumeRecoveryPoints(
Consumer listVolumeRecoveryPointsRequest) {
return listVolumeRecoveryPoints(ListVolumeRecoveryPointsRequest.builder().applyMutation(listVolumeRecoveryPointsRequest)
.build());
}
/**
*
* Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the
* volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the
* DescribeCachediSCSIVolumes API.
*
*
* The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can
* optionally specify the Limit field in the body to limit the number of volumes in the response. If
* the number of volumes returned in the response is truncated, the response includes a Marker field. You can use
* this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only
* supported in the cached volume and stored volume gateway types.
*
*
* @param listVolumesRequest
* A JSON object that contains one or more of the following fields:
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the ListVolumes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumes
* @see AWS API
* Documentation
*/
default CompletableFuture listVolumes(ListVolumesRequest listVolumesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the
* volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the
* DescribeCachediSCSIVolumes API.
*
*
* The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can
* optionally specify the Limit field in the body to limit the number of volumes in the response. If
* the number of volumes returned in the response is truncated, the response includes a Marker field. You can use
* this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only
* supported in the cached volume and stored volume gateway types.
*
*
*
* This is a convenience which creates an instance of the {@link ListVolumesRequest.Builder} avoiding the need to
* create one manually via {@link ListVolumesRequest#builder()}
*
*
* @param listVolumesRequest
* A {@link Consumer} that will call methods on {@link ListVolumesInput.Builder} to create a request. A JSON
* object that contains one or more of the following fields:
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the ListVolumes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumes
* @see AWS API
* Documentation
*/
default CompletableFuture listVolumes(Consumer listVolumesRequest) {
return listVolumes(ListVolumesRequest.builder().applyMutation(listVolumesRequest).build());
}
/**
*
* Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the
* volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the
* DescribeCachediSCSIVolumes API.
*
*
* The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can
* optionally specify the Limit field in the body to limit the number of volumes in the response. If
* the number of volumes returned in the response is truncated, the response includes a Marker field. You can use
* this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only
* supported in the cached volume and stored volume gateway types.
*
*
* @return A Java Future containing the result of the ListVolumes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumes
* @see AWS API
* Documentation
*/
default CompletableFuture listVolumes() {
return listVolumes(ListVolumesRequest.builder().build());
}
/**
*
* Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the
* volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the
* DescribeCachediSCSIVolumes API.
*
*
* The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can
* optionally specify the Limit field in the body to limit the number of volumes in the response. If
* the number of volumes returned in the response is truncated, the response includes a Marker field. You can use
* this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only
* supported in the cached volume and stored volume gateway types.
*
*
*
* This is a variant of
* {@link #listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListVolumesPublisher publisher = client.listVolumesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListVolumesPublisher publisher = client.listVolumesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumes
* @see AWS API
* Documentation
*/
default ListVolumesPublisher listVolumesPaginator() {
return listVolumesPaginator(ListVolumesRequest.builder().build());
}
/**
*
* Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the
* volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the
* DescribeCachediSCSIVolumes API.
*
*
* The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can
* optionally specify the Limit field in the body to limit the number of volumes in the response. If
* the number of volumes returned in the response is truncated, the response includes a Marker field. You can use
* this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only
* supported in the cached volume and stored volume gateway types.
*
*
*
* This is a variant of
* {@link #listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListVolumesPublisher publisher = client.listVolumesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListVolumesPublisher publisher = client.listVolumesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)} operation.
*
*
* @param listVolumesRequest
* A JSON object that contains one or more of the following fields:
*
* -
*
*
* -
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumes
* @see AWS API
* Documentation
*/
default ListVolumesPublisher listVolumesPaginator(ListVolumesRequest listVolumesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the
* volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the
* DescribeCachediSCSIVolumes API.
*
*
* The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can
* optionally specify the Limit field in the body to limit the number of volumes in the response. If
* the number of volumes returned in the response is truncated, the response includes a Marker field. You can use
* this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only
* supported in the cached volume and stored volume gateway types.
*
*
*
* This is a variant of
* {@link #listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListVolumesPublisher publisher = client.listVolumesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.storagegateway.paginators.ListVolumesPublisher publisher = client.listVolumesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListVolumesRequest.Builder} avoiding the need to
* create one manually via {@link ListVolumesRequest#builder()}
*
*
* @param listVolumesRequest
* A {@link Consumer} that will call methods on {@link ListVolumesInput.Builder} to create a request. A JSON
* object that contains one or more of the following fields:
*
* -
*
*
* -
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ListVolumes
* @see AWS API
* Documentation
*/
default ListVolumesPublisher listVolumesPaginator(Consumer listVolumesRequest) {
return listVolumesPaginator(ListVolumesRequest.builder().applyMutation(listVolumesRequest).build());
}
/**
*
* Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to
* Amazon S3.
*
*
* AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file
* share up to that point in time have been uploaded to Amazon S3. These files include files written to the file
* share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you
* notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification
* through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file
* gateways.
*
*
* For more information, see Getting File Upload Notification in the Storage Gateway User Guide
* (https://docs.aws.amazon
* .com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).
*
*
* @param notifyWhenUploadedRequest
* @return A Java Future containing the result of the NotifyWhenUploaded operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.NotifyWhenUploaded
* @see AWS API Documentation
*/
default CompletableFuture notifyWhenUploaded(NotifyWhenUploadedRequest notifyWhenUploadedRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to
* Amazon S3.
*
*
* AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file
* share up to that point in time have been uploaded to Amazon S3. These files include files written to the file
* share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you
* notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification
* through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file
* gateways.
*
*
* For more information, see Getting File Upload Notification in the Storage Gateway User Guide
* (https://docs.aws.amazon
* .com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).
*
*
*
* This is a convenience which creates an instance of the {@link NotifyWhenUploadedRequest.Builder} avoiding the
* need to create one manually via {@link NotifyWhenUploadedRequest#builder()}
*
*
* @param notifyWhenUploadedRequest
* A {@link Consumer} that will call methods on {@link NotifyWhenUploadedInput.Builder} to create a request.
* @return A Java Future containing the result of the NotifyWhenUploaded operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.NotifyWhenUploaded
* @see AWS API Documentation
*/
default CompletableFuture notifyWhenUploaded(
Consumer notifyWhenUploadedRequest) {
return notifyWhenUploaded(NotifyWhenUploadedRequest.builder().applyMutation(notifyWhenUploadedRequest).build());
}
/**
*
* Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were
* added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This
* operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon
* CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations.
*
*
* When this API is called, it only initiates the refresh operation. When the API call completes and returns a
* success code, it doesn't necessarily mean that the file refresh has completed. You should use the
* refresh-complete notification to determine that the operation has completed before you check for new files on the
* gateway file share. You can subscribe to be notified through an CloudWatch event when your
* RefreshCache operation completes.
*
*
* Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We
* recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more
* information, see Getting Notified About File Operations.
*
*
* If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an
* InvalidGatewayRequestException error because too many requests were sent to the server.
*
*
* For more information, see
* "https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification".
*
*
* @param refreshCacheRequest
* RefreshCacheInput
* @return A Java Future containing the result of the RefreshCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.RefreshCache
* @see AWS
* API Documentation
*/
default CompletableFuture refreshCache(RefreshCacheRequest refreshCacheRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were
* added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This
* operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon
* CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations.
*
*
* When this API is called, it only initiates the refresh operation. When the API call completes and returns a
* success code, it doesn't necessarily mean that the file refresh has completed. You should use the
* refresh-complete notification to determine that the operation has completed before you check for new files on the
* gateway file share. You can subscribe to be notified through an CloudWatch event when your
* RefreshCache operation completes.
*
*
* Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We
* recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more
* information, see Getting Notified About File Operations.
*
*
* If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an
* InvalidGatewayRequestException error because too many requests were sent to the server.
*
*
* For more information, see
* "https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification".
*
*
*
* This is a convenience which creates an instance of the {@link RefreshCacheRequest.Builder} avoiding the need to
* create one manually via {@link RefreshCacheRequest#builder()}
*
*
* @param refreshCacheRequest
* A {@link Consumer} that will call methods on {@link RefreshCacheInput.Builder} to create a request.
* RefreshCacheInput
* @return A Java Future containing the result of the RefreshCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.RefreshCache
* @see AWS
* API Documentation
*/
default CompletableFuture refreshCache(Consumer refreshCacheRequest) {
return refreshCache(RefreshCacheRequest.builder().applyMutation(refreshCacheRequest).build());
}
/**
*
* Removes one or more tags from the specified resource. This operation is supported in storage gateways of all
* types.
*
*
* @param removeTagsFromResourceRequest
* RemoveTagsFromResourceInput
* @return A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.RemoveTagsFromResource
* @see AWS API Documentation
*/
default CompletableFuture removeTagsFromResource(
RemoveTagsFromResourceRequest removeTagsFromResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more tags from the specified resource. This operation is supported in storage gateways of all
* types.
*
*
*
* This is a convenience which creates an instance of the {@link RemoveTagsFromResourceRequest.Builder} avoiding the
* need to create one manually via {@link RemoveTagsFromResourceRequest#builder()}
*
*
* @param removeTagsFromResourceRequest
* A {@link Consumer} that will call methods on {@link RemoveTagsFromResourceInput.Builder} to create a
* request. RemoveTagsFromResourceInput
* @return A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.RemoveTagsFromResource
* @see AWS API Documentation
*/
default CompletableFuture removeTagsFromResource(
Consumer removeTagsFromResourceRequest) {
return removeTagsFromResource(RemoveTagsFromResourceRequest.builder().applyMutation(removeTagsFromResourceRequest)
.build());
}
/**
*
* Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache
* storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes
* in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a
* cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks.
* This operation is only supported in the cached volume and tape types.
*
*
*
* If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be
* lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must
* configure at least one new cache disk for your gateway to function properly.
*
*
*
* @param resetCacheRequest
* @return A Java Future containing the result of the ResetCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ResetCache
* @see AWS API
* Documentation
*/
default CompletableFuture resetCache(ResetCacheRequest resetCacheRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache
* storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes
* in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a
* cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks.
* This operation is only supported in the cached volume and tape types.
*
*
*
* If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be
* lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must
* configure at least one new cache disk for your gateway to function properly.
*
*
*
* This is a convenience which creates an instance of the {@link ResetCacheRequest.Builder} avoiding the need to
* create one manually via {@link ResetCacheRequest#builder()}
*
*
* @param resetCacheRequest
* A {@link Consumer} that will call methods on {@link ResetCacheInput.Builder} to create a request.
* @return A Java Future containing the result of the ResetCache operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ResetCache
* @see AWS API
* Documentation
*/
default CompletableFuture resetCache(Consumer resetCacheRequest) {
return resetCache(ResetCacheRequest.builder().applyMutation(resetCacheRequest).build());
}
/**
*
* Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in
* the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway,
* even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway
* type.
*
*
* Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must
* archive the tape again before you can retrieve it to another gateway. This operation is only supported in the
* tape gateway type.
*
*
* @param retrieveTapeArchiveRequest
* RetrieveTapeArchiveInput
* @return A Java Future containing the result of the RetrieveTapeArchive operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.RetrieveTapeArchive
* @see AWS API Documentation
*/
default CompletableFuture retrieveTapeArchive(
RetrieveTapeArchiveRequest retrieveTapeArchiveRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in
* the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway,
* even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway
* type.
*
*
* Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must
* archive the tape again before you can retrieve it to another gateway. This operation is only supported in the
* tape gateway type.
*
*
*
* This is a convenience which creates an instance of the {@link RetrieveTapeArchiveRequest.Builder} avoiding the
* need to create one manually via {@link RetrieveTapeArchiveRequest#builder()}
*
*
* @param retrieveTapeArchiveRequest
* A {@link Consumer} that will call methods on {@link RetrieveTapeArchiveInput.Builder} to create a request.
* RetrieveTapeArchiveInput
* @return A Java Future containing the result of the RetrieveTapeArchive operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.RetrieveTapeArchive
* @see AWS API Documentation
*/
default CompletableFuture retrieveTapeArchive(
Consumer retrieveTapeArchiveRequest) {
return retrieveTapeArchive(RetrieveTapeArchiveRequest.builder().applyMutation(retrieveTapeArchiveRequest).build());
}
/**
*
* Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway
* type.
*
*
* A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If
* your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
*
*
*
* The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be
* retrieved to only a tape gateway. There is no charge for retrieving recovery points.
*
*
*
* @param retrieveTapeRecoveryPointRequest
* RetrieveTapeRecoveryPointInput
* @return A Java Future containing the result of the RetrieveTapeRecoveryPoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.RetrieveTapeRecoveryPoint
* @see AWS API Documentation
*/
default CompletableFuture retrieveTapeRecoveryPoint(
RetrieveTapeRecoveryPointRequest retrieveTapeRecoveryPointRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway
* type.
*
*
* A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If
* your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.
*
*
*
* The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be
* retrieved to only a tape gateway. There is no charge for retrieving recovery points.
*
*
*
* This is a convenience which creates an instance of the {@link RetrieveTapeRecoveryPointRequest.Builder} avoiding
* the need to create one manually via {@link RetrieveTapeRecoveryPointRequest#builder()}
*
*
* @param retrieveTapeRecoveryPointRequest
* A {@link Consumer} that will call methods on {@link RetrieveTapeRecoveryPointInput.Builder} to create a
* request. RetrieveTapeRecoveryPointInput
* @return A Java Future containing the result of the RetrieveTapeRecoveryPoint operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.RetrieveTapeRecoveryPoint
* @see AWS API Documentation
*/
default CompletableFuture retrieveTapeRecoveryPoint(
Consumer retrieveTapeRecoveryPointRequest) {
return retrieveTapeRecoveryPoint(RetrieveTapeRecoveryPointRequest.builder()
.applyMutation(retrieveTapeRecoveryPointRequest).build());
}
/**
*
* Sets the password for your VM local console. When you log in to the local console for the first time, you log in
* to the VM with the default credentials. We recommend that you set a new password. You don't need to know the
* default password to set a new password.
*
*
* @param setLocalConsolePasswordRequest
* SetLocalConsolePasswordInput
* @return A Java Future containing the result of the SetLocalConsolePassword operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.SetLocalConsolePassword
* @see AWS API Documentation
*/
default CompletableFuture setLocalConsolePassword(
SetLocalConsolePasswordRequest setLocalConsolePasswordRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets the password for your VM local console. When you log in to the local console for the first time, you log in
* to the VM with the default credentials. We recommend that you set a new password. You don't need to know the
* default password to set a new password.
*
*
*
* This is a convenience which creates an instance of the {@link SetLocalConsolePasswordRequest.Builder} avoiding
* the need to create one manually via {@link SetLocalConsolePasswordRequest#builder()}
*
*
* @param setLocalConsolePasswordRequest
* A {@link Consumer} that will call methods on {@link SetLocalConsolePasswordInput.Builder} to create a
* request. SetLocalConsolePasswordInput
* @return A Java Future containing the result of the SetLocalConsolePassword operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.SetLocalConsolePassword
* @see AWS API Documentation
*/
default CompletableFuture setLocalConsolePassword(
Consumer setLocalConsolePasswordRequest) {
return setLocalConsolePassword(SetLocalConsolePasswordRequest.builder().applyMutation(setLocalConsolePasswordRequest)
.build());
}
/**
*
* Sets the password for the guest user smbguest. The smbguest user is the user when the
* authentication method for the file share is set to GuestAccess.
*
*
* @param setSmbGuestPasswordRequest
* SetSMBGuestPasswordInput
* @return A Java Future containing the result of the SetSMBGuestPassword operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.SetSMBGuestPassword
* @see AWS API Documentation
*/
default CompletableFuture setSMBGuestPassword(
SetSmbGuestPasswordRequest setSmbGuestPasswordRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets the password for the guest user smbguest. The smbguest user is the user when the
* authentication method for the file share is set to GuestAccess.
*
*
*
* This is a convenience which creates an instance of the {@link SetSmbGuestPasswordRequest.Builder} avoiding the
* need to create one manually via {@link SetSmbGuestPasswordRequest#builder()}
*
*
* @param setSmbGuestPasswordRequest
* A {@link Consumer} that will call methods on {@link SetSMBGuestPasswordInput.Builder} to create a request.
* SetSMBGuestPasswordInput
* @return A Java Future containing the result of the SetSMBGuestPassword operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.SetSMBGuestPassword
* @see AWS API Documentation
*/
default CompletableFuture setSMBGuestPassword(
Consumer setSmbGuestPasswordRequest) {
return setSMBGuestPassword(SetSmbGuestPasswordRequest.builder().applyMutation(setSmbGuestPasswordRequest).build());
}
/**
*
* Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in
* the body of your request.
*
*
* The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the
* host VM.
*
*
*
* If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to
* avoid unpredictable conditions.
*
*
*
* After the gateway is shutdown, you cannot call any other API except StartGateway,
* DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway.
* Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
*
*
*
* When you make a shutdown request, you will get a 200 OK success response immediately. However, it
* might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to
* check the status. For more information, see ActivateGateway.
*
*
*
* If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer
* pay software charges associated with the gateway.
*
*
* @param shutdownGatewayRequest
* A JSON object containing the of the gateway to shut down.
* @return A Java Future containing the result of the ShutdownGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ShutdownGateway
* @see AWS
* API Documentation
*/
default CompletableFuture shutdownGateway(ShutdownGatewayRequest shutdownGatewayRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in
* the body of your request.
*
*
* The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the
* host VM.
*
*
*
* If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to
* avoid unpredictable conditions.
*
*
*
* After the gateway is shutdown, you cannot call any other API except StartGateway,
* DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway.
* Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
*
*
*
* When you make a shutdown request, you will get a 200 OK success response immediately. However, it
* might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to
* check the status. For more information, see ActivateGateway.
*
*
*
* If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer
* pay software charges associated with the gateway.
*
*
*
* This is a convenience which creates an instance of the {@link ShutdownGatewayRequest.Builder} avoiding the need
* to create one manually via {@link ShutdownGatewayRequest#builder()}
*
*
* @param shutdownGatewayRequest
* A {@link Consumer} that will call methods on {@link ShutdownGatewayInput.Builder} to create a request. A
* JSON object containing the of the gateway to shut down.
* @return A Java Future containing the result of the ShutdownGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.ShutdownGateway
* @see AWS
* API Documentation
*/
default CompletableFuture shutdownGateway(
Consumer shutdownGatewayRequest) {
return shutdownGateway(ShutdownGatewayRequest.builder().applyMutation(shutdownGatewayRequest).build());
}
/**
*
* Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host
* environment. This request only initiates the test and that a successful response only indicates that the test was
* started. It doesn't indicate that the test passed. For the status of the test, invoke the
* DescribeAvailabilityMonitorTest API.
*
*
*
* Starting this test will cause your gateway to go offline for a brief period.
*
*
*
* @param startAvailabilityMonitorTestRequest
* @return A Java Future containing the result of the StartAvailabilityMonitorTest operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.StartAvailabilityMonitorTest
* @see AWS API Documentation
*/
default CompletableFuture startAvailabilityMonitorTest(
StartAvailabilityMonitorTestRequest startAvailabilityMonitorTestRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host
* environment. This request only initiates the test and that a successful response only indicates that the test was
* started. It doesn't indicate that the test passed. For the status of the test, invoke the
* DescribeAvailabilityMonitorTest API.
*
*
*
* Starting this test will cause your gateway to go offline for a brief period.
*
*
*
* This is a convenience which creates an instance of the {@link StartAvailabilityMonitorTestRequest.Builder}
* avoiding the need to create one manually via {@link StartAvailabilityMonitorTestRequest#builder()}
*
*
* @param startAvailabilityMonitorTestRequest
* A {@link Consumer} that will call methods on {@link StartAvailabilityMonitorTestInput.Builder} to create a
* request.
* @return A Java Future containing the result of the StartAvailabilityMonitorTest operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.StartAvailabilityMonitorTest
* @see AWS API Documentation
*/
default CompletableFuture startAvailabilityMonitorTest(
Consumer startAvailabilityMonitorTestRequest) {
return startAvailabilityMonitorTest(StartAvailabilityMonitorTestRequest.builder()
.applyMutation(startAvailabilityMonitorTestRequest).build());
}
/**
*
* Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can
* then make other API calls, your applications can read from or write to the gateway's storage volumes and you will
* be able to take snapshot backups.
*
*
*
* When you make a request, you will get a 200 OK success response immediately. However, it might take some time for
* the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any
* additional API calls. For more information, see ActivateGateway.
*
*
*
* To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
*
*
* @param startGatewayRequest
* A JSON object containing the of the gateway to start.
* @return A Java Future containing the result of the StartGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.StartGateway
* @see AWS
* API Documentation
*/
default CompletableFuture startGateway(StartGatewayRequest startGatewayRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can
* then make other API calls, your applications can read from or write to the gateway's storage volumes and you will
* be able to take snapshot backups.
*
*
*
* When you make a request, you will get a 200 OK success response immediately. However, it might take some time for
* the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any
* additional API calls. For more information, see ActivateGateway.
*
*
*
* To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.
*
*
*
* This is a convenience which creates an instance of the {@link StartGatewayRequest.Builder} avoiding the need to
* create one manually via {@link StartGatewayRequest#builder()}
*
*
* @param startGatewayRequest
* A {@link Consumer} that will call methods on {@link StartGatewayInput.Builder} to create a request. A JSON
* object containing the of the gateway to start.
* @return A Java Future containing the result of the StartGateway operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.StartGateway
* @see AWS
* API Documentation
*/
default CompletableFuture startGateway(Consumer startGatewayRequest) {
return startGateway(StartGatewayRequest.builder().applyMutation(startGatewayRequest).build());
}
/**
*
* Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit
* or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This
* operation is supported for the stored volume, cached volume and tape gateway types.'
*
*
* By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have
* any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
*
*
* To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
*
*
* @param updateBandwidthRateLimitRequest
* A JSON object containing one or more of the following fields:
*
* -
*
* UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
*
*
* -
*
* UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
*
*
* @return A Java Future containing the result of the UpdateBandwidthRateLimit operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.UpdateBandwidthRateLimit
* @see AWS API Documentation
*/
default CompletableFuture updateBandwidthRateLimit(
UpdateBandwidthRateLimitRequest updateBandwidthRateLimitRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit
* or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This
* operation is supported for the stored volume, cached volume and tape gateway types.'
*
*
* By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have
* any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.
*
*
* To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateBandwidthRateLimitRequest.Builder} avoiding
* the need to create one manually via {@link UpdateBandwidthRateLimitRequest#builder()}
*
*
* @param updateBandwidthRateLimitRequest
* A {@link Consumer} that will call methods on {@link UpdateBandwidthRateLimitInput.Builder} to create a
* request. A JSON object containing one or more of the following fields:
*
* -
*
* UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec
*
*
* -
*
* UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
*
*
* @return A Java Future containing the result of the UpdateBandwidthRateLimit operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.UpdateBandwidthRateLimit
* @see AWS API Documentation
*/
default CompletableFuture updateBandwidthRateLimit(
Consumer updateBandwidthRateLimitRequest) {
return updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest.builder().applyMutation(updateBandwidthRateLimitRequest)
.build());
}
/**
*
* Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By
* default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is
* supported in the volume and tape gateway types.
*
*
*
* When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect
* with the new credentials.
*
*
*
* @param updateChapCredentialsRequest
* A JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
* UpdateChapCredentialsInput$SecretToAuthenticateInitiator
*
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the UpdateChapCredentials operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.UpdateChapCredentials
* @see AWS API Documentation
*/
default CompletableFuture updateChapCredentials(
UpdateChapCredentialsRequest updateChapCredentialsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By
* default, a gateway does not have CHAP enabled; however, for added security, you might use it. This operation is
* supported in the volume and tape gateway types.
*
*
*
* When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect
* with the new credentials.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateChapCredentialsRequest.Builder} avoiding the
* need to create one manually via {@link UpdateChapCredentialsRequest#builder()}
*
*
* @param updateChapCredentialsRequest
* A {@link Consumer} that will call methods on {@link UpdateChapCredentialsInput.Builder} to create a
* request. A JSON object containing one or more of the following fields:
*
* -
*
*
* -
*
* UpdateChapCredentialsInput$SecretToAuthenticateInitiator
*
*
* -
*
*
* -
*
*
* @return A Java Future containing the result of the UpdateChapCredentials operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.UpdateChapCredentials
* @see AWS API Documentation
*/
default CompletableFuture updateChapCredentials(
Consumer updateChapCredentialsRequest) {
return updateChapCredentials(UpdateChapCredentialsRequest.builder().applyMutation(updateChapCredentialsRequest).build());
}
/**
*
* Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to
* update, use the Amazon Resource Name (ARN) of the gateway in your request.
*
*
*
* For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway
* name. However, changing the name of the gateway has no effect on the gateway's ARN.
*
*
*
* @param updateGatewayInformationRequest
* @return A Java Future containing the result of the UpdateGatewayInformation operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.UpdateGatewayInformation
* @see AWS API Documentation
*/
default CompletableFuture updateGatewayInformation(
UpdateGatewayInformationRequest updateGatewayInformationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to
* update, use the Amazon Resource Name (ARN) of the gateway in your request.
*
*
*
* For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway
* name. However, changing the name of the gateway has no effect on the gateway's ARN.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateGatewayInformationRequest.Builder} avoiding
* the need to create one manually via {@link UpdateGatewayInformationRequest#builder()}
*
*
* @param updateGatewayInformationRequest
* A {@link Consumer} that will call methods on {@link UpdateGatewayInformationInput.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateGatewayInformation operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.UpdateGatewayInformation
* @see AWS API Documentation
*/
default CompletableFuture updateGatewayInformation(
Consumer updateGatewayInformationRequest) {
return updateGatewayInformation(UpdateGatewayInformationRequest.builder().applyMutation(updateGatewayInformationRequest)
.build());
}
/**
*
* Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
*
*
*
* When you make this request, you get a 200 OK success response immediately. However, it might take
* some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in
* the STATE_RUNNING state.
*
*
*
* A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your
* applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator
* timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.
*
*
*
* @param updateGatewaySoftwareNowRequest
* A JSON object containing the of the gateway to update.
* @return A Java Future containing the result of the UpdateGatewaySoftwareNow operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.UpdateGatewaySoftwareNow
* @see AWS API Documentation
*/
default CompletableFuture updateGatewaySoftwareNow(
UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
*
*
*
* When you make this request, you get a 200 OK success response immediately. However, it might take
* some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in
* the STATE_RUNNING state.
*
*
*
* A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your
* applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator
* timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateGatewaySoftwareNowRequest.Builder} avoiding
* the need to create one manually via {@link UpdateGatewaySoftwareNowRequest#builder()}
*
*
* @param updateGatewaySoftwareNowRequest
* A {@link Consumer} that will call methods on {@link UpdateGatewaySoftwareNowInput.Builder} to create a
* request. A JSON object containing the of the gateway to update.
* @return A Java Future containing the result of the UpdateGatewaySoftwareNow operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to
* the service. For more information, see the error and message fields.
* - InternalServerErrorException An internal server error has occurred during the request. For more
* information, see the error and message fields.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - StorageGatewayException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample StorageGatewayAsyncClient.UpdateGatewaySoftwareNow
* @see AWS API Documentation
*/
default CompletableFuture updateGatewaySoftwareNow(
Consumer updateGatewaySoftwareNowRequest) {
return updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest.builder().applyMutation(updateGatewaySoftwareNowRequest)
.build());
}
/**
*
* Updates a gateway's weekly maintenance start time information, including day and time of the week. The
* maintenance time is the time in your gateway's time zone.
*
*
* @param updateMaintenanceStartTimeRequest
* A JSON object containing the following fields:
*
* -
*
*