SnapshotRestoreRequest Class

public final class SnapshotRestoreRequest
extends ProxyOnlyResource

Details about app recovery operation.

Constructor Summary

Constructor Description
SnapshotRestoreRequest()

Creates an instance of SnapshotRestoreRequest class.

Method Summary

Modifier and Type Method and Description
static SnapshotRestoreRequest fromJson(JsonReader jsonReader)

Reads an instance of SnapshotRestoreRequest from the JsonReader.

String id()

Get the id property: Resource Id.

Boolean ignoreConflictingHostNames()

Get the ignoreConflictingHostNames property: If true, custom hostname conflicts will be ignored when recovering to a target web app.

String name()

Get the name property: Resource Name.

Boolean overwrite()

Get the overwrite property: If true the restore operation can overwrite source app; otherwise, false.

Boolean recoverConfiguration()

Get the recoverConfiguration property: If true, site configuration, in addition to content, will be reverted.

SnapshotRecoverySource recoverySource()

Get the recoverySource property: Optional.

String snapshotTime()

Get the snapshotTime property: Point in time in which the app restore should be done, formatted as a DateTime string.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Resource type.

Boolean useDRSecondary()

Get the useDRSecondary property: If true, the snapshot is retrieved from DRSecondary endpoint.

void validate()

Validates the instance.

SnapshotRestoreRequest withIgnoreConflictingHostNames(Boolean ignoreConflictingHostNames)

Set the ignoreConflictingHostNames property: If true, custom hostname conflicts will be ignored when recovering to a target web app.

SnapshotRestoreRequest withKind(String kind)

Set the kind property: Kind of resource.

SnapshotRestoreRequest withOverwrite(Boolean overwrite)

Set the overwrite property: If true the restore operation can overwrite source app; otherwise, false.

SnapshotRestoreRequest withRecoverConfiguration(Boolean recoverConfiguration)

Set the recoverConfiguration property: If true, site configuration, in addition to content, will be reverted.

SnapshotRestoreRequest withRecoverySource(SnapshotRecoverySource recoverySource)

Set the recoverySource property: Optional.

SnapshotRestoreRequest withSnapshotTime(String snapshotTime)

Set the snapshotTime property: Point in time in which the app restore should be done, formatted as a DateTime string.

SnapshotRestoreRequest withUseDRSecondary(Boolean useDRSecondary)

Set the useDRSecondary property: If true, the snapshot is retrieved from DRSecondary endpoint.

Methods inherited from ProxyOnlyResource

Methods inherited from java.lang.Object

Constructor Details

SnapshotRestoreRequest

public SnapshotRestoreRequest()

Creates an instance of SnapshotRestoreRequest class.

Method Details

fromJson

public static SnapshotRestoreRequest fromJson(JsonReader jsonReader)

Reads an instance of SnapshotRestoreRequest from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SnapshotRestoreRequest 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 SnapshotRestoreRequest.

id

public String id()

Get the id property: Resource Id.

Overrides:

SnapshotRestoreRequest.id()

Returns:

the id value.

ignoreConflictingHostNames

public Boolean ignoreConflictingHostNames()

Get the ignoreConflictingHostNames property: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.

Returns:

the ignoreConflictingHostNames value.

name

public String name()

Get the name property: Resource Name.

Overrides:

SnapshotRestoreRequest.name()

Returns:

the name value.

overwrite

public Boolean overwrite()

Get the overwrite property: If true the restore operation can overwrite source app; otherwise, false.

Returns:

the overwrite value.

recoverConfiguration

public Boolean recoverConfiguration()

Get the recoverConfiguration property: If true, site configuration, in addition to content, will be reverted.

Returns:

the recoverConfiguration value.

recoverySource

public SnapshotRecoverySource recoverySource()

Get the recoverySource property: Optional. Specifies the web app that snapshot contents will be retrieved from. If empty, the targeted web app will be used as the source.

Returns:

the recoverySource value.

snapshotTime

public String snapshotTime()

Get the snapshotTime property: Point in time in which the app restore should be done, formatted as a DateTime string.

Returns:

the snapshotTime value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SnapshotRestoreRequest.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Resource type.

Overrides:

SnapshotRestoreRequest.type()

Returns:

the type value.

useDRSecondary

public Boolean useDRSecondary()

Get the useDRSecondary property: If true, the snapshot is retrieved from DRSecondary endpoint.

Returns:

the useDRSecondary value.

validate

public void validate()

Validates the instance.

Overrides:

SnapshotRestoreRequest.validate()

withIgnoreConflictingHostNames

public SnapshotRestoreRequest withIgnoreConflictingHostNames(Boolean ignoreConflictingHostNames)

Set the ignoreConflictingHostNames property: If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.

Parameters:

ignoreConflictingHostNames - the ignoreConflictingHostNames value to set.

Returns:

the SnapshotRestoreRequest object itself.

withKind

public SnapshotRestoreRequest withKind(String kind)

Set the kind property: Kind of resource.

Overrides:

SnapshotRestoreRequest.withKind(String kind)

Parameters:

kind

withOverwrite

public SnapshotRestoreRequest withOverwrite(Boolean overwrite)

Set the overwrite property: If true the restore operation can overwrite source app; otherwise, false.

Parameters:

overwrite - the overwrite value to set.

Returns:

the SnapshotRestoreRequest object itself.

withRecoverConfiguration

public SnapshotRestoreRequest withRecoverConfiguration(Boolean recoverConfiguration)

Set the recoverConfiguration property: If true, site configuration, in addition to content, will be reverted.

Parameters:

recoverConfiguration - the recoverConfiguration value to set.

Returns:

the SnapshotRestoreRequest object itself.

withRecoverySource

public SnapshotRestoreRequest withRecoverySource(SnapshotRecoverySource recoverySource)

Set the recoverySource property: Optional. Specifies the web app that snapshot contents will be retrieved from. If empty, the targeted web app will be used as the source.

Parameters:

recoverySource - the recoverySource value to set.

Returns:

the SnapshotRestoreRequest object itself.

withSnapshotTime

public SnapshotRestoreRequest withSnapshotTime(String snapshotTime)

Set the snapshotTime property: Point in time in which the app restore should be done, formatted as a DateTime string.

Parameters:

snapshotTime - the snapshotTime value to set.

Returns:

the SnapshotRestoreRequest object itself.

withUseDRSecondary

public SnapshotRestoreRequest withUseDRSecondary(Boolean useDRSecondary)

Set the useDRSecondary property: If true, the snapshot is retrieved from DRSecondary endpoint.

Parameters:

useDRSecondary - the useDRSecondary value to set.

Returns:

the SnapshotRestoreRequest object itself.

Applies to