com.oracle.bmc.core

Class BlockstorageClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.core.BlockstorageClient

All Implemented Interfaces:

Blockstorage, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class BlockstorageClient
extends BaseSyncClient
implements Blockstorage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockstorageClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
protected ExecutorService	executorService
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Blockstorage.

Constructor Summary

Constructors

Constructor and Description
BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
BlockstorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
BlockstorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
BlockstorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static BlockstorageClient.Builder	builder() Create a builder for this client.
ChangeBootVolumeBackupCompartmentResponse	changeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest request) Moves a boot volume backup into a different compartment within the same tenancy.
ChangeBootVolumeCompartmentResponse	changeBootVolumeCompartment(ChangeBootVolumeCompartmentRequest request) Moves a boot volume into a different compartment within the same tenancy.
ChangeVolumeBackupCompartmentResponse	changeVolumeBackupCompartment(ChangeVolumeBackupCompartmentRequest request) Moves a volume backup into a different compartment within the same tenancy.
ChangeVolumeCompartmentResponse	changeVolumeCompartment(ChangeVolumeCompartmentRequest request) Moves a volume into a different compartment within the same tenancy.
ChangeVolumeGroupBackupCompartmentResponse	changeVolumeGroupBackupCompartment(ChangeVolumeGroupBackupCompartmentRequest request) Moves a volume group backup into a different compartment within the same tenancy.
ChangeVolumeGroupCompartmentResponse	changeVolumeGroupCompartment(ChangeVolumeGroupCompartmentRequest request) Moves a volume group into a different compartment within the same tenancy.
void	close()
CopyBootVolumeBackupResponse	copyBootVolumeBackup(CopyBootVolumeBackupRequest request) Creates a boot volume backup copy in specified region.
CopyVolumeBackupResponse	copyVolumeBackup(CopyVolumeBackupRequest request) Creates a volume backup copy in specified region.
CopyVolumeGroupBackupResponse	copyVolumeGroupBackup(CopyVolumeGroupBackupRequest request) Creates a volume group backup copy in specified region.
CreateBootVolumeResponse	createBootVolume(CreateBootVolumeRequest request) Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup.
CreateBootVolumeBackupResponse	createBootVolumeBackup(CreateBootVolumeBackupRequest request) Creates a new boot volume backup of the specified boot volume.
CreateVolumeResponse	createVolume(CreateVolumeRequest request) Creates a new volume in the specified compartment.
CreateVolumeBackupResponse	createVolumeBackup(CreateVolumeBackupRequest request) Creates a new backup of the specified volume.
CreateVolumeBackupPolicyResponse	createVolumeBackupPolicy(CreateVolumeBackupPolicyRequest request) Creates a new user defined backup policy.
CreateVolumeBackupPolicyAssignmentResponse	createVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request) Assigns a volume backup policy to the specified volume.
CreateVolumeGroupResponse	createVolumeGroup(CreateVolumeGroupRequest request) Creates a new volume group in the specified compartment.
CreateVolumeGroupBackupResponse	createVolumeGroupBackup(CreateVolumeGroupBackupRequest request) Creates a new backup volume group of the specified volume group.
DeleteBootVolumeResponse	deleteBootVolume(DeleteBootVolumeRequest request) Deletes the specified boot volume.
DeleteBootVolumeBackupResponse	deleteBootVolumeBackup(DeleteBootVolumeBackupRequest request) Deletes a boot volume backup.
DeleteBootVolumeKmsKeyResponse	deleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest request) Removes the specified boot volume’s assigned Vault Service encryption key.
DeleteVolumeResponse	deleteVolume(DeleteVolumeRequest request) Deletes the specified volume.
DeleteVolumeBackupResponse	deleteVolumeBackup(DeleteVolumeBackupRequest request) Deletes a volume backup.
DeleteVolumeBackupPolicyResponse	deleteVolumeBackupPolicy(DeleteVolumeBackupPolicyRequest request) Deletes a user defined backup policy.
DeleteVolumeBackupPolicyAssignmentResponse	deleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request) Deletes a volume backup policy assignment.
DeleteVolumeGroupResponse	deleteVolumeGroup(DeleteVolumeGroupRequest request) Deletes the specified volume group.
DeleteVolumeGroupBackupResponse	deleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest request) Deletes a volume group backup.
DeleteVolumeKmsKeyResponse	deleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request) Removes the specified volume’s assigned Vault service encryption key.
GetBlockVolumeReplicaResponse	getBlockVolumeReplica(GetBlockVolumeReplicaRequest request) Gets information for the specified block volume replica.
GetBootVolumeResponse	getBootVolume(GetBootVolumeRequest request) Gets information for the specified boot volume.
GetBootVolumeBackupResponse	getBootVolumeBackup(GetBootVolumeBackupRequest request) Gets information for the specified boot volume backup.
GetBootVolumeKmsKeyResponse	getBootVolumeKmsKey(GetBootVolumeKmsKeyRequest request) Gets the Vault service encryption key assigned to the specified boot volume.
GetBootVolumeReplicaResponse	getBootVolumeReplica(GetBootVolumeReplicaRequest request) Gets information for the specified boot volume replica.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
BlockstoragePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetVolumeResponse	getVolume(GetVolumeRequest request) Gets information for the specified volume.
GetVolumeBackupResponse	getVolumeBackup(GetVolumeBackupRequest request) Gets information for the specified volume backup.
GetVolumeBackupPolicyResponse	getVolumeBackupPolicy(GetVolumeBackupPolicyRequest request) Gets information for the specified volume backup policy.
GetVolumeBackupPolicyAssetAssignmentResponse	getVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest request) Gets the volume backup policy assignment for the specified volume.
GetVolumeBackupPolicyAssignmentResponse	getVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest request) Gets information for the specified volume backup policy assignment.
GetVolumeGroupResponse	getVolumeGroup(GetVolumeGroupRequest request) Gets information for the specified volume group.
GetVolumeGroupBackupResponse	getVolumeGroupBackup(GetVolumeGroupBackupRequest request) Gets information for the specified volume group backup.
GetVolumeGroupReplicaResponse	getVolumeGroupReplica(GetVolumeGroupReplicaRequest request) Gets information for the specified volume group replica.
GetVolumeKmsKeyResponse	getVolumeKmsKey(GetVolumeKmsKeyRequest request) Gets the Vault service encryption key assigned to the specified volume.
BlockstorageWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListBlockVolumeReplicasResponse	listBlockVolumeReplicas(ListBlockVolumeReplicasRequest request) Lists the block volume replicas in the specified compartment and availability domain.
ListBootVolumeBackupsResponse	listBootVolumeBackups(ListBootVolumeBackupsRequest request) Lists the boot volume backups in the specified compartment.
ListBootVolumeReplicasResponse	listBootVolumeReplicas(ListBootVolumeReplicasRequest request) Lists the boot volume replicas in the specified compartment and availability domain.
ListBootVolumesResponse	listBootVolumes(ListBootVolumesRequest request) Lists the boot volumes in the specified compartment and availability domain.
ListVolumeBackupPoliciesResponse	listVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request) Lists all the volume backup policies available in the specified compartment.
ListVolumeBackupsResponse	listVolumeBackups(ListVolumeBackupsRequest request) Lists the volume backups in the specified compartment.
ListVolumeGroupBackupsResponse	listVolumeGroupBackups(ListVolumeGroupBackupsRequest request) Lists the volume group backups in the specified compartment.
ListVolumeGroupReplicasResponse	listVolumeGroupReplicas(ListVolumeGroupReplicasRequest request) Lists the volume group replicas in the specified compartment.
ListVolumeGroupsResponse	listVolumeGroups(ListVolumeGroupsRequest request) Lists the volume groups in the specified compartment and availability domain.
ListVolumesResponse	listVolumes(ListVolumesRequest request) Lists the volumes in the specified compartment and availability domain.
BlockstorageWaiters	newWaiters(WorkRequest workRequestClient) Creates a new BlockstorageWaiters for resources for this service.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateBootVolumeResponse	updateBootVolume(UpdateBootVolumeRequest request) Updates the specified boot volume’s display name, defined tags, and free-form tags.
UpdateBootVolumeBackupResponse	updateBootVolumeBackup(UpdateBootVolumeBackupRequest request) Updates the display name for the specified boot volume backup.
UpdateBootVolumeKmsKeyResponse	updateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest request) Updates the specified volume with a new Vault service master encryption key.
UpdateVolumeResponse	updateVolume(UpdateVolumeRequest request) Updates the specified volume’s display name.
UpdateVolumeBackupResponse	updateVolumeBackup(UpdateVolumeBackupRequest request) Updates the display name for the specified volume backup.
UpdateVolumeBackupPolicyResponse	updateVolumeBackupPolicy(UpdateVolumeBackupPolicyRequest request) Updates a user defined backup policy.
UpdateVolumeGroupResponse	updateVolumeGroup(UpdateVolumeGroupRequest request) Updates the set of volumes in a volume group along with the display name.
UpdateVolumeGroupBackupResponse	updateVolumeGroupBackup(UpdateVolumeGroupBackupRequest request) Updates the display name for the specified volume group backup.
UpdateVolumeKmsKeyResponse	updateVolumeKmsKey(UpdateVolumeKmsKeyRequest request) Updates the specified volume with a new Key Management master encryption key.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.core.Blockstorage

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Blockstorage.

executorService

protected final ExecutorService executorService

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

BlockstorageClient

@Deprecated
public BlockstorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockstorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

BlockstorageClient

@Deprecated
public BlockstorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockstorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

BlockstorageClient

@Deprecated
public BlockstorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockstorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

BlockstorageClient

@Deprecated
public BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockstorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

BlockstorageClient

@Deprecated
public BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory,
                                      List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockstorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

BlockstorageClient

@Deprecated
public BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory,
                                      List<ClientConfigurator> additionalClientConfigurators,
                                      String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockstorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

BlockstorageClient

@Deprecated
public BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory,
                                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                      List<ClientConfigurator> additionalClientConfigurators,
                                      String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockstorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

BlockstorageClient

@Deprecated
public BlockstorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory,
                                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                      List<ClientConfigurator> additionalClientConfigurators,
                                      String endpoint,
                                      ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockstorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - BlockstorageClient.Builder.executorService

Method Detail

builder

public static BlockstorageClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Blockstorage

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface Blockstorage

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Blockstorage

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface Blockstorage

Parameters:

regionId - The public region ID.

changeBootVolumeBackupCompartment

public ChangeBootVolumeBackupCompartmentResponse changeBootVolumeBackupCompartment(ChangeBootVolumeBackupCompartmentRequest request)

Description copied from interface: Blockstorage

Moves a boot volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeBootVolumeBackupCompartment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeBootVolumeCompartment

public ChangeBootVolumeCompartmentResponse changeBootVolumeCompartment(ChangeBootVolumeCompartmentRequest request)

Description copied from interface: Blockstorage

Moves a boot volume into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeBootVolumeCompartment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeVolumeBackupCompartment

public ChangeVolumeBackupCompartmentResponse changeVolumeBackupCompartment(ChangeVolumeBackupCompartmentRequest request)

Description copied from interface: Blockstorage

Moves a volume backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeVolumeBackupCompartment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeVolumeCompartment

public ChangeVolumeCompartmentResponse changeVolumeCompartment(ChangeVolumeCompartmentRequest request)

Description copied from interface: Blockstorage

Moves a volume into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeVolumeCompartment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeVolumeGroupBackupCompartment

public ChangeVolumeGroupBackupCompartmentResponse changeVolumeGroupBackupCompartment(ChangeVolumeGroupBackupCompartmentRequest request)

Description copied from interface: Blockstorage

Moves a volume group backup into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeVolumeGroupBackupCompartment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeVolumeGroupCompartment

public ChangeVolumeGroupCompartmentResponse changeVolumeGroupCompartment(ChangeVolumeGroupCompartmentRequest request)

Description copied from interface: Blockstorage

Moves a volume group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeVolumeGroupCompartment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

copyBootVolumeBackup

public CopyBootVolumeBackupResponse copyBootVolumeBackup(CopyBootVolumeBackupRequest request)

Description copied from interface: Blockstorage

Creates a boot volume backup copy in specified region. For general information about volume backups, see Overview of Boot Volume Backups

Specified by:

copyBootVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

copyVolumeBackup

public CopyVolumeBackupResponse copyVolumeBackup(CopyVolumeBackupRequest request)

Description copied from interface: Blockstorage

Creates a volume backup copy in specified region. For general information about volume backups, see Overview of Block Volume Service Backups

Specified by:

copyVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

copyVolumeGroupBackup

public CopyVolumeGroupBackupResponse copyVolumeGroupBackup(CopyVolumeGroupBackupRequest request)

Description copied from interface: Blockstorage

Creates a volume group backup copy in specified region. For general information about volume group backups, see Overview of Block Volume Backups.

Specified by:

copyVolumeGroupBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createBootVolume

public CreateBootVolumeResponse createBootVolume(CreateBootVolumeRequest request)

Description copied from interface: Blockstorage

Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see Boot Volumes. You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

Specified by:

createBootVolume in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createBootVolumeBackup

public CreateBootVolumeBackupResponse createBootVolumeBackup(CreateBootVolumeBackupRequest request)

Description copied from interface: Blockstorage

Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see Overview of Boot Volume Backups

When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

Specified by:

createBootVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVolume

public CreateVolumeResponse createVolume(CreateVolumeRequest request)

Description copied from interface: Blockstorage

Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see Overview of Block Volume Service.

A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.

You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

Specified by:

createVolume in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVolumeBackup

public CreateVolumeBackupResponse createVolumeBackup(CreateVolumeBackupRequest request)

Description copied from interface: Blockstorage

Creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service Backups

When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

Specified by:

createVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVolumeBackupPolicy

public CreateVolumeBackupPolicyResponse createVolumeBackupPolicy(CreateVolumeBackupPolicyRequest request)

Description copied from interface: Blockstorage

Creates a new user defined backup policy.

For more information about Oracle defined backup policies and user defined backup policies, see [Policy-Based Backups](https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).

Specified by:

createVolumeBackupPolicy in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVolumeBackupPolicyAssignment

public CreateVolumeBackupPolicyAssignmentResponse createVolumeBackupPolicyAssignment(CreateVolumeBackupPolicyAssignmentRequest request)

Description copied from interface: Blockstorage

Assigns a volume backup policy to the specified volume. Note that a given volume can only have one backup policy assigned to it. If this operation is used for a volume that already has a different backup policy assigned, the prior backup policy will be silently unassigned.

Specified by:

createVolumeBackupPolicyAssignment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVolumeGroup

public CreateVolumeGroupResponse createVolumeGroup(CreateVolumeGroupRequest request)

Description copied from interface: Blockstorage

Creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. You may optionally specify a display name for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

For more information, see [Volume Groups](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm).

Specified by:

createVolumeGroup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVolumeGroupBackup

public CreateVolumeGroupBackupResponse createVolumeGroupBackup(CreateVolumeGroupBackupRequest request)

Description copied from interface: Blockstorage

Creates a new backup volume group of the specified volume group. For more information, see Volume Groups.

Specified by:

createVolumeGroupBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteBootVolume

public DeleteBootVolumeResponse deleteBootVolume(DeleteBootVolumeRequest request)

Description copied from interface: Blockstorage

Deletes the specified boot volume. The volume cannot have an active connection to an instance. To disconnect the boot volume from a connected instance, see Disconnecting From a Boot Volume. Warning: All data on the boot volume will be permanently lost when the boot volume is deleted.

Specified by:

deleteBootVolume in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteBootVolumeBackup

public DeleteBootVolumeBackupResponse deleteBootVolumeBackup(DeleteBootVolumeBackupRequest request)

Description copied from interface: Blockstorage

Deletes a boot volume backup.

Specified by:

deleteBootVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteBootVolumeKmsKey

public DeleteBootVolumeKmsKeyResponse deleteBootVolumeKmsKey(DeleteBootVolumeKmsKeyRequest request)

Description copied from interface: Blockstorage

Removes the specified boot volume’s assigned Vault Service encryption key.

Specified by:

deleteBootVolumeKmsKey in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVolume

public DeleteVolumeResponse deleteVolume(DeleteVolumeRequest request)

Description copied from interface: Blockstorage

Deletes the specified volume. The volume cannot have an active connection to an instance. To disconnect the volume from a connected instance, see Disconnecting From a Volume. Warning: All data on the volume will be permanently lost when the volume is deleted.

Specified by:

deleteVolume in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVolumeBackup

public DeleteVolumeBackupResponse deleteVolumeBackup(DeleteVolumeBackupRequest request)

Description copied from interface: Blockstorage

Deletes a volume backup.

Specified by:

deleteVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVolumeBackupPolicy

public DeleteVolumeBackupPolicyResponse deleteVolumeBackupPolicy(DeleteVolumeBackupPolicyRequest request)

Description copied from interface: Blockstorage

Deletes a user defined backup policy. For more information about user defined backup policies, see Policy-Based Backups.

Avoid entering confidential information.

Specified by:

deleteVolumeBackupPolicy in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVolumeBackupPolicyAssignment

public DeleteVolumeBackupPolicyAssignmentResponse deleteVolumeBackupPolicyAssignment(DeleteVolumeBackupPolicyAssignmentRequest request)

Description copied from interface: Blockstorage

Deletes a volume backup policy assignment.

Specified by:

deleteVolumeBackupPolicyAssignment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVolumeGroup

public DeleteVolumeGroupResponse deleteVolumeGroup(DeleteVolumeGroupRequest request)

Description copied from interface: Blockstorage

Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups.

Specified by:

deleteVolumeGroup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVolumeGroupBackup

public DeleteVolumeGroupBackupResponse deleteVolumeGroupBackup(DeleteVolumeGroupBackupRequest request)

Description copied from interface: Blockstorage

Deletes a volume group backup. This operation deletes all the backups in the volume group. For more information, see Volume Groups.

Specified by:

deleteVolumeGroupBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVolumeKmsKey

public DeleteVolumeKmsKeyResponse deleteVolumeKmsKey(DeleteVolumeKmsKeyRequest request)

Description copied from interface: Blockstorage

Removes the specified volume’s assigned Vault service encryption key.

Specified by:

deleteVolumeKmsKey in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBlockVolumeReplica

public GetBlockVolumeReplicaResponse getBlockVolumeReplica(GetBlockVolumeReplicaRequest request)

Description copied from interface: Blockstorage

Gets information for the specified block volume replica.

Specified by:

getBlockVolumeReplica in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBootVolume

public GetBootVolumeResponse getBootVolume(GetBootVolumeRequest request)

Description copied from interface: Blockstorage

Gets information for the specified boot volume.

Specified by:

getBootVolume in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBootVolumeBackup

public GetBootVolumeBackupResponse getBootVolumeBackup(GetBootVolumeBackupRequest request)

Description copied from interface: Blockstorage

Gets information for the specified boot volume backup.

Specified by:

getBootVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBootVolumeKmsKey

public GetBootVolumeKmsKeyResponse getBootVolumeKmsKey(GetBootVolumeKmsKeyRequest request)

Description copied from interface: Blockstorage

Gets the Vault service encryption key assigned to the specified boot volume.

Specified by:

getBootVolumeKmsKey in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBootVolumeReplica

public GetBootVolumeReplicaResponse getBootVolumeReplica(GetBootVolumeReplicaRequest request)

Description copied from interface: Blockstorage

Gets information for the specified boot volume replica.

Specified by:

getBootVolumeReplica in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolume

public GetVolumeResponse getVolume(GetVolumeRequest request)

Description copied from interface: Blockstorage

Gets information for the specified volume.

Specified by:

getVolume in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolumeBackup

public GetVolumeBackupResponse getVolumeBackup(GetVolumeBackupRequest request)

Description copied from interface: Blockstorage

Gets information for the specified volume backup.

Specified by:

getVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolumeBackupPolicy

public GetVolumeBackupPolicyResponse getVolumeBackupPolicy(GetVolumeBackupPolicyRequest request)

Description copied from interface: Blockstorage

Gets information for the specified volume backup policy.

Specified by:

getVolumeBackupPolicy in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolumeBackupPolicyAssetAssignment

public GetVolumeBackupPolicyAssetAssignmentResponse getVolumeBackupPolicyAssetAssignment(GetVolumeBackupPolicyAssetAssignmentRequest request)

Description copied from interface: Blockstorage

Gets the volume backup policy assignment for the specified volume. The assetId query parameter is required, and the returned list will contain at most one item, since volume can only have one volume backup policy assigned at a time.

Specified by:

getVolumeBackupPolicyAssetAssignment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolumeBackupPolicyAssignment

public GetVolumeBackupPolicyAssignmentResponse getVolumeBackupPolicyAssignment(GetVolumeBackupPolicyAssignmentRequest request)

Description copied from interface: Blockstorage

Gets information for the specified volume backup policy assignment.

Specified by:

getVolumeBackupPolicyAssignment in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolumeGroup

public GetVolumeGroupResponse getVolumeGroup(GetVolumeGroupRequest request)

Description copied from interface: Blockstorage

Gets information for the specified volume group. For more information, see Volume Groups.

Specified by:

getVolumeGroup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolumeGroupBackup

public GetVolumeGroupBackupResponse getVolumeGroupBackup(GetVolumeGroupBackupRequest request)

Description copied from interface: Blockstorage

Gets information for the specified volume group backup. For more information, see Volume Groups.

Specified by:

getVolumeGroupBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolumeGroupReplica

public GetVolumeGroupReplicaResponse getVolumeGroupReplica(GetVolumeGroupReplicaRequest request)

Description copied from interface: Blockstorage

Gets information for the specified volume group replica.

Specified by:

getVolumeGroupReplica in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVolumeKmsKey

public GetVolumeKmsKeyResponse getVolumeKmsKey(GetVolumeKmsKeyRequest request)

Description copied from interface: Blockstorage

Gets the Vault service encryption key assigned to the specified volume.

Specified by:

getVolumeKmsKey in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBlockVolumeReplicas

public ListBlockVolumeReplicasResponse listBlockVolumeReplicas(ListBlockVolumeReplicasRequest request)

Description copied from interface: Blockstorage

Lists the block volume replicas in the specified compartment and availability domain.

Specified by:

listBlockVolumeReplicas in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBootVolumeBackups

public ListBootVolumeBackupsResponse listBootVolumeBackups(ListBootVolumeBackupsRequest request)

Description copied from interface: Blockstorage

Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.

Specified by:

listBootVolumeBackups in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBootVolumeReplicas

public ListBootVolumeReplicasResponse listBootVolumeReplicas(ListBootVolumeReplicasRequest request)

Description copied from interface: Blockstorage

Lists the boot volume replicas in the specified compartment and availability domain.

Specified by:

listBootVolumeReplicas in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBootVolumes

public ListBootVolumesResponse listBootVolumes(ListBootVolumesRequest request)

Description copied from interface: Blockstorage

Lists the boot volumes in the specified compartment and availability domain.

Specified by:

listBootVolumes in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVolumeBackupPolicies

public ListVolumeBackupPoliciesResponse listVolumeBackupPolicies(ListVolumeBackupPoliciesRequest request)

Description copied from interface: Blockstorage

Lists all the volume backup policies available in the specified compartment.

For more information about Oracle defined backup policies and user defined backup policies, see [Policy-Based Backups](https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).

Specified by:

listVolumeBackupPolicies in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVolumeBackups

public ListVolumeBackupsResponse listVolumeBackups(ListVolumeBackupsRequest request)

Description copied from interface: Blockstorage

Lists the volume backups in the specified compartment. You can filter the results by volume.

Specified by:

listVolumeBackups in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVolumeGroupBackups

public ListVolumeGroupBackupsResponse listVolumeGroupBackups(ListVolumeGroupBackupsRequest request)

Description copied from interface: Blockstorage

Lists the volume group backups in the specified compartment. You can filter the results by volume group. For more information, see Volume Groups.

Specified by:

listVolumeGroupBackups in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVolumeGroupReplicas

public ListVolumeGroupReplicasResponse listVolumeGroupReplicas(ListVolumeGroupReplicasRequest request)

Description copied from interface: Blockstorage

Lists the volume group replicas in the specified compartment. You can filter the results by volume group. For more information, see Volume Group Replication.

Specified by:

listVolumeGroupReplicas in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVolumeGroups

public ListVolumeGroupsResponse listVolumeGroups(ListVolumeGroupsRequest request)

Description copied from interface: Blockstorage

Lists the volume groups in the specified compartment and availability domain. For more information, see Volume Groups.

Specified by:

listVolumeGroups in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVolumes

public ListVolumesResponse listVolumes(ListVolumesRequest request)

Description copied from interface: Blockstorage

Lists the volumes in the specified compartment and availability domain.

Specified by:

listVolumes in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateBootVolume

public UpdateBootVolumeResponse updateBootVolume(UpdateBootVolumeRequest request)

Description copied from interface: Blockstorage

Updates the specified boot volume’s display name, defined tags, and free-form tags.

Specified by:

updateBootVolume in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateBootVolumeBackup

public UpdateBootVolumeBackupResponse updateBootVolumeBackup(UpdateBootVolumeBackupRequest request)

Description copied from interface: Blockstorage

Updates the display name for the specified boot volume backup. Avoid entering confidential information.

Specified by:

updateBootVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateBootVolumeKmsKey

public UpdateBootVolumeKmsKeyResponse updateBootVolumeKmsKey(UpdateBootVolumeKmsKeyRequest request)

Description copied from interface: Blockstorage

Updates the specified volume with a new Vault service master encryption key.

Specified by:

updateBootVolumeKmsKey in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVolume

public UpdateVolumeResponse updateVolume(UpdateVolumeRequest request)

Description copied from interface: Blockstorage

Updates the specified volume’s display name. Avoid entering confidential information.

Specified by:

updateVolume in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVolumeBackup

public UpdateVolumeBackupResponse updateVolumeBackup(UpdateVolumeBackupRequest request)

Description copied from interface: Blockstorage

Updates the display name for the specified volume backup. Avoid entering confidential information.

Specified by:

updateVolumeBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVolumeBackupPolicy

public UpdateVolumeBackupPolicyResponse updateVolumeBackupPolicy(UpdateVolumeBackupPolicyRequest request)

Description copied from interface: Blockstorage

Updates a user defined backup policy. For more information about user defined backup policies, see Policy-Based Backups.

Avoid entering confidential information.

Specified by:

updateVolumeBackupPolicy in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVolumeGroup

public UpdateVolumeGroupResponse updateVolumeGroup(UpdateVolumeGroupRequest request)

Description copied from interface: Blockstorage

Updates the set of volumes in a volume group along with the display name. Use this operation to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the volume group. If the volume ID is not specified in the call, it will be removed from the volume group. Avoid entering confidential information.

For more information, see [Volume Groups](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm).

Specified by:

updateVolumeGroup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVolumeGroupBackup

public UpdateVolumeGroupBackupResponse updateVolumeGroupBackup(UpdateVolumeGroupBackupRequest request)

Description copied from interface: Blockstorage

Updates the display name for the specified volume group backup. For more information, see Volume Groups.

Specified by:

updateVolumeGroupBackup in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVolumeKmsKey

public UpdateVolumeKmsKeyResponse updateVolumeKmsKey(UpdateVolumeKmsKeyRequest request)

Description copied from interface: Blockstorage

Updates the specified volume with a new Key Management master encryption key.

Specified by:

updateVolumeKmsKey in interface Blockstorage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public BlockstorageWaiters getWaiters()

Description copied from interface: Blockstorage

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Blockstorage

Returns:

The service waiters.

newWaiters

public BlockstorageWaiters newWaiters(WorkRequest workRequestClient)

Description copied from interface: Blockstorage

Creates a new BlockstorageWaiters for resources for this service.

Specified by:

newWaiters in interface Blockstorage

Parameters:

workRequestClient - The work request service client used to query for work request status

Returns:

The service waiters.

getPaginators

public BlockstoragePaginators getPaginators()

Description copied from interface: Blockstorage

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface Blockstorage

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()