MoveCollection Interface

Package:

com.azure.resourcemanager.resourcemover.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resourcemover:1.1.0

public interface MoveCollection

An immutable client-side representation of MoveCollection.

Method Summary

Modifier and Type	Method and Description
abstract OperationStatus	bulkRemove() Removes the set of move resources included in the request body from move collection.
abstract OperationStatus	bulkRemove(BulkRemoveRequest body, Context context) Removes the set of move resources included in the request body from move collection.
abstract OperationStatus	commit() Commits the set of resources included in the request body.
abstract OperationStatus	commit(CommitRequest body, Context context) Commits the set of resources included in the request body.
abstract OperationStatus	discard() Discards the set of resources included in the request body.
abstract OperationStatus	discard(DiscardRequest body, Context context) Discards the set of resources included in the request body.
abstract String	etag() Gets the etag property: The etag of the resource.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract Identity	identity() Gets the identity property: Defines the MSI properties of the Move Collection.
abstract OperationStatus	initiateMove() Moves the set of resources included in the request body.
abstract OperationStatus	initiateMove(ResourceMoveRequest body, Context context) Moves the set of resources included in the request body.
abstract MoveCollectionInner	innerModel() Gets the inner com.azure.resourcemanager.resourcemover.fluent.models.MoveCollectionInner object.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract String	name() Gets the name property: The name of the resource.
abstract OperationStatus	prepare() Initiates prepare for the set of resources included in the request body.
abstract OperationStatus	prepare(PrepareRequest body, Context context) Initiates prepare for the set of resources included in the request body.
abstract MoveCollectionProperties	properties() Gets the properties property: Defines the move collection properties.
abstract MoveCollection	refresh() Refreshes the resource to sync with Azure.
abstract MoveCollection	refresh(Context context) Refreshes the resource to sync with Azure.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract OperationStatus	resolveDependencies() Computes, resolves and validate the dependencies of the moveResources in the move collection.
abstract OperationStatus	resolveDependencies(Context context) Computes, resolves and validate the dependencies of the moveResources in the move collection.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract SystemData	systemData() Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the MoveCollection resource.

Method Details

bulkRemove

public abstract OperationStatus bulkRemove()

Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Returns:

operation status REST resource.

bulkRemove

public abstract OperationStatus bulkRemove(BulkRemoveRequest body, Context context)

Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Parameters:

body - Defines the request body for bulk remove of move resources operation.

context - The context to associate with this operation.

Returns:

operation status REST resource.

commit

public abstract OperationStatus commit()

Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Returns:

operation status REST resource.

commit

public abstract OperationStatus commit(CommitRequest body, Context context)

Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Parameters:

body - Defines the request body for commit operation.

context - The context to associate with this operation.

Returns:

operation status REST resource.

discard

public abstract OperationStatus discard()

Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Returns:

operation status REST resource.

discard

public abstract OperationStatus discard(DiscardRequest body, Context context)

Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Parameters:

body - Defines the request body for discard operation.

context - The context to associate with this operation.

Returns:

operation status REST resource.

etag

public abstract String etag()

Gets the etag property: The etag of the resource.

Returns:

the etag value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identity

public abstract Identity identity()

Gets the identity property: Defines the MSI properties of the Move Collection.

Returns:

the identity value.

initiateMove

public abstract OperationStatus initiateMove()

Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Returns:

operation status REST resource.

initiateMove

public abstract OperationStatus initiateMove(ResourceMoveRequest body, Context context)

Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Parameters:

body - Defines the request body for resource move operation.

context - The context to associate with this operation.

Returns:

operation status REST resource.

innerModel

public abstract MoveCollectionInner innerModel()

Gets the inner com.azure.resourcemanager.resourcemover.fluent.models.MoveCollectionInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

prepare

public abstract OperationStatus prepare()

Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Returns:

operation status REST resource.

prepare

public abstract OperationStatus prepare(PrepareRequest body, Context context)

Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

Parameters:

body - Defines the request body for initiate prepare operation.

context - The context to associate with this operation.

Returns:

operation status REST resource.

properties

public abstract MoveCollectionProperties properties()

Gets the properties property: Defines the move collection properties.

Returns:

the properties value.

refresh

public abstract MoveCollection refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract MoveCollection refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resolveDependencies

public abstract OperationStatus resolveDependencies()

Computes, resolves and validate the dependencies of the moveResources in the move collection.

Returns:

operation status REST resource.

resolveDependencies

public abstract OperationStatus resolveDependencies(Context context)

Computes, resolves and validate the dependencies of the moveResources in the move collection.

Parameters:

context - The context to associate with this operation.

Returns:

operation status REST resource.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

systemData

public abstract SystemData systemData()

Gets the systemData property: Metadata pertaining to creation and last modification of the resource.

Returns:

the systemData value.

tags

public abstract Map tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract MoveCollection.Update update()

Begins update for the MoveCollection resource.

Returns:

the stage of resource update.