Share via


MongoDbCancelCommand Class

public final class MongoDbCancelCommand
extends CommandPropertiesInner

Properties for the command that cancels a migration in whole or in part.

Constructor Summary

Constructor Description
MongoDbCancelCommand()

Creates an instance of MongoDbCancelCommand class.

Method Summary

Modifier and Type Method and Description
CommandType commandType()

Get the commandType property: Command type.

List<ManagementError> errors()

Get the errors property: Array of errors.

static MongoDbCancelCommand fromJson(JsonReader jsonReader)

Reads an instance of MongoDbCancelCommand from the JsonReader.

MongoDbCommandInput input()

Get the input property: Command input.

CommandState state()

Get the state property: The state of the command.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

MongoDbCancelCommand withInput(MongoDbCommandInput input)

Set the input property: Command input.

Methods inherited from CommandPropertiesInner

Methods inherited from java.lang.Object

Constructor Details

MongoDbCancelCommand

public MongoDbCancelCommand()

Creates an instance of MongoDbCancelCommand class.

Method Details

commandType

public CommandType commandType()

Get the commandType property: Command type.

Overrides:

MongoDbCancelCommand.commandType()

Returns:

the commandType value.

errors

public List<ManagementError> errors()

Get the errors property: Array of errors. This is ignored if submitted.

Overrides:

MongoDbCancelCommand.errors()

Returns:

the errors value.

fromJson

public static MongoDbCancelCommand fromJson(JsonReader jsonReader)

Reads an instance of MongoDbCancelCommand from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MongoDbCancelCommand if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the MongoDbCancelCommand.

input

public MongoDbCommandInput input()

Get the input property: Command input.

Returns:

the input value.

state

public CommandState state()

Get the state property: The state of the command. This is ignored if submitted.

Overrides:

MongoDbCancelCommand.state()

Returns:

the state value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

MongoDbCancelCommand.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

MongoDbCancelCommand.validate()

withInput

public MongoDbCancelCommand withInput(MongoDbCommandInput input)

Set the input property: Command input.

Parameters:

input - the input value to set.

Returns:

the MongoDbCancelCommand object itself.

Applies to