Class VmMigrationSettings (1.43.0)

public class VmMigrationSettings extends ClientSettings<VmMigrationSettings>

Settings class to configure an instance of VmMigrationClient.

The default instance has everything set to sensible defaults:

  • The default service address (vmmigration.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getSource to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VmMigrationSettings.Builder vmMigrationSettingsBuilder = VmMigrationSettings.newBuilder();
 vmMigrationSettingsBuilder
     .getSourceSettings()
     .setRetrySettings(
         vmMigrationSettingsBuilder
             .getSourceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VmMigrationSettings vmMigrationSettings = vmMigrationSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > VmMigrationSettings

Static Methods

create(VmMigrationStubSettings stub)

public static final VmMigrationSettings create(VmMigrationStubSettings stub)
Parameter
Name Description
stub VmMigrationStubSettings
Returns
Type Description
VmMigrationSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static VmMigrationSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
VmMigrationSettings.Builder

newBuilder(ClientContext clientContext)

public static VmMigrationSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
VmMigrationSettings.Builder

newHttpJsonBuilder()

public static VmMigrationSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
VmMigrationSettings.Builder

Constructors

VmMigrationSettings(VmMigrationSettings.Builder settingsBuilder)

protected VmMigrationSettings(VmMigrationSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder VmMigrationSettings.Builder

Methods

addGroupMigrationOperationSettings()

public OperationCallSettings<AddGroupMigrationRequest,AddGroupMigrationResponse,OperationMetadata> addGroupMigrationOperationSettings()

Returns the object with the settings used for calls to addGroupMigration.

addGroupMigrationSettings()

public UnaryCallSettings<AddGroupMigrationRequest,Operation> addGroupMigrationSettings()

Returns the object with the settings used for calls to addGroupMigration.

cancelCloneJobOperationSettings()

public OperationCallSettings<CancelCloneJobRequest,CancelCloneJobResponse,OperationMetadata> cancelCloneJobOperationSettings()

Returns the object with the settings used for calls to cancelCloneJob.

cancelCloneJobSettings()

public UnaryCallSettings<CancelCloneJobRequest,Operation> cancelCloneJobSettings()

Returns the object with the settings used for calls to cancelCloneJob.

cancelCutoverJobOperationSettings()

public OperationCallSettings<CancelCutoverJobRequest,CancelCutoverJobResponse,OperationMetadata> cancelCutoverJobOperationSettings()

Returns the object with the settings used for calls to cancelCutoverJob.

cancelCutoverJobSettings()

public UnaryCallSettings<CancelCutoverJobRequest,Operation> cancelCutoverJobSettings()

Returns the object with the settings used for calls to cancelCutoverJob.

createCloneJobOperationSettings()

public OperationCallSettings<CreateCloneJobRequest,CloneJob,OperationMetadata> createCloneJobOperationSettings()

Returns the object with the settings used for calls to createCloneJob.

createCloneJobSettings()

public UnaryCallSettings<CreateCloneJobRequest,Operation> createCloneJobSettings()

Returns the object with the settings used for calls to createCloneJob.

createCutoverJobOperationSettings()

public OperationCallSettings<CreateCutoverJobRequest,CutoverJob,OperationMetadata> createCutoverJobOperationSettings()

Returns the object with the settings used for calls to createCutoverJob.

createCutoverJobSettings()

public UnaryCallSettings<CreateCutoverJobRequest,Operation> createCutoverJobSettings()

Returns the object with the settings used for calls to createCutoverJob.

createDatacenterConnectorOperationSettings()

public OperationCallSettings<CreateDatacenterConnectorRequest,DatacenterConnector,OperationMetadata> createDatacenterConnectorOperationSettings()

Returns the object with the settings used for calls to createDatacenterConnector.

createDatacenterConnectorSettings()

public UnaryCallSettings<CreateDatacenterConnectorRequest,Operation> createDatacenterConnectorSettings()

Returns the object with the settings used for calls to createDatacenterConnector.

createGroupOperationSettings()

public OperationCallSettings<CreateGroupRequest,Group,OperationMetadata> createGroupOperationSettings()

Returns the object with the settings used for calls to createGroup.

createGroupSettings()

public UnaryCallSettings<CreateGroupRequest,Operation> createGroupSettings()

Returns the object with the settings used for calls to createGroup.

Returns
Type Description
UnaryCallSettings<CreateGroupRequest,Operation>

createMigratingVmOperationSettings()

public OperationCallSettings<CreateMigratingVmRequest,MigratingVm,OperationMetadata> createMigratingVmOperationSettings()

Returns the object with the settings used for calls to createMigratingVm.

createMigratingVmSettings()

public UnaryCallSettings<CreateMigratingVmRequest,Operation> createMigratingVmSettings()

Returns the object with the settings used for calls to createMigratingVm.

createSourceOperationSettings()

public OperationCallSettings<CreateSourceRequest,Source,OperationMetadata> createSourceOperationSettings()

Returns the object with the settings used for calls to createSource.

createSourceSettings()

public UnaryCallSettings<CreateSourceRequest,Operation> createSourceSettings()

Returns the object with the settings used for calls to createSource.

Returns
Type Description
UnaryCallSettings<CreateSourceRequest,Operation>

createTargetProjectOperationSettings()

public OperationCallSettings<CreateTargetProjectRequest,TargetProject,OperationMetadata> createTargetProjectOperationSettings()

Returns the object with the settings used for calls to createTargetProject.

createTargetProjectSettings()

public UnaryCallSettings<CreateTargetProjectRequest,Operation> createTargetProjectSettings()

Returns the object with the settings used for calls to createTargetProject.

createUtilizationReportOperationSettings()

public OperationCallSettings<CreateUtilizationReportRequest,UtilizationReport,OperationMetadata> createUtilizationReportOperationSettings()

Returns the object with the settings used for calls to createUtilizationReport.

createUtilizationReportSettings()

public UnaryCallSettings<CreateUtilizationReportRequest,Operation> createUtilizationReportSettings()

Returns the object with the settings used for calls to createUtilizationReport.

deleteDatacenterConnectorOperationSettings()

public OperationCallSettings<DeleteDatacenterConnectorRequest,Empty,OperationMetadata> deleteDatacenterConnectorOperationSettings()

Returns the object with the settings used for calls to deleteDatacenterConnector.

deleteDatacenterConnectorSettings()

public UnaryCallSettings<DeleteDatacenterConnectorRequest,Operation> deleteDatacenterConnectorSettings()

Returns the object with the settings used for calls to deleteDatacenterConnector.

deleteGroupOperationSettings()

public OperationCallSettings<DeleteGroupRequest,Empty,OperationMetadata> deleteGroupOperationSettings()

Returns the object with the settings used for calls to deleteGroup.

deleteGroupSettings()

public UnaryCallSettings<DeleteGroupRequest,Operation> deleteGroupSettings()

Returns the object with the settings used for calls to deleteGroup.

Returns
Type Description
UnaryCallSettings<DeleteGroupRequest,Operation>

deleteMigratingVmOperationSettings()

public OperationCallSettings<DeleteMigratingVmRequest,Empty,OperationMetadata> deleteMigratingVmOperationSettings()

Returns the object with the settings used for calls to deleteMigratingVm.

deleteMigratingVmSettings()

public UnaryCallSettings<DeleteMigratingVmRequest,Operation> deleteMigratingVmSettings()

Returns the object with the settings used for calls to deleteMigratingVm.

deleteSourceOperationSettings()

public OperationCallSettings<DeleteSourceRequest,Empty,OperationMetadata> deleteSourceOperationSettings()

Returns the object with the settings used for calls to deleteSource.

deleteSourceSettings()

public UnaryCallSettings<DeleteSourceRequest,Operation> deleteSourceSettings()

Returns the object with the settings used for calls to deleteSource.

Returns
Type Description
UnaryCallSettings<DeleteSourceRequest,Operation>

deleteTargetProjectOperationSettings()

public OperationCallSettings<DeleteTargetProjectRequest,Empty,OperationMetadata> deleteTargetProjectOperationSettings()

Returns the object with the settings used for calls to deleteTargetProject.

deleteTargetProjectSettings()

public UnaryCallSettings<DeleteTargetProjectRequest,Operation> deleteTargetProjectSettings()

Returns the object with the settings used for calls to deleteTargetProject.

deleteUtilizationReportOperationSettings()

public OperationCallSettings<DeleteUtilizationReportRequest,Empty,OperationMetadata> deleteUtilizationReportOperationSettings()

Returns the object with the settings used for calls to deleteUtilizationReport.

deleteUtilizationReportSettings()

public UnaryCallSettings<DeleteUtilizationReportRequest,Operation> deleteUtilizationReportSettings()

Returns the object with the settings used for calls to deleteUtilizationReport.

fetchInventorySettings()

public UnaryCallSettings<FetchInventoryRequest,FetchInventoryResponse> fetchInventorySettings()

Returns the object with the settings used for calls to fetchInventory.

finalizeMigrationOperationSettings()

public OperationCallSettings<FinalizeMigrationRequest,FinalizeMigrationResponse,OperationMetadata> finalizeMigrationOperationSettings()

Returns the object with the settings used for calls to finalizeMigration.

finalizeMigrationSettings()

public UnaryCallSettings<FinalizeMigrationRequest,Operation> finalizeMigrationSettings()

Returns the object with the settings used for calls to finalizeMigration.

getCloneJobSettings()

public UnaryCallSettings<GetCloneJobRequest,CloneJob> getCloneJobSettings()

Returns the object with the settings used for calls to getCloneJob.

Returns
Type Description
UnaryCallSettings<GetCloneJobRequest,CloneJob>

getCutoverJobSettings()

public UnaryCallSettings<GetCutoverJobRequest,CutoverJob> getCutoverJobSettings()

Returns the object with the settings used for calls to getCutoverJob.

getDatacenterConnectorSettings()

public UnaryCallSettings<GetDatacenterConnectorRequest,DatacenterConnector> getDatacenterConnectorSettings()

Returns the object with the settings used for calls to getDatacenterConnector.

getGroupSettings()

public UnaryCallSettings<GetGroupRequest,Group> getGroupSettings()

Returns the object with the settings used for calls to getGroup.

Returns
Type Description
UnaryCallSettings<GetGroupRequest,Group>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getMigratingVmSettings()

public UnaryCallSettings<GetMigratingVmRequest,MigratingVm> getMigratingVmSettings()

Returns the object with the settings used for calls to getMigratingVm.

getReplicationCycleSettings()

public UnaryCallSettings<GetReplicationCycleRequest,ReplicationCycle> getReplicationCycleSettings()

Returns the object with the settings used for calls to getReplicationCycle.

getSourceSettings()

public UnaryCallSettings<GetSourceRequest,Source> getSourceSettings()

Returns the object with the settings used for calls to getSource.

Returns
Type Description
UnaryCallSettings<GetSourceRequest,Source>

getTargetProjectSettings()

public UnaryCallSettings<GetTargetProjectRequest,TargetProject> getTargetProjectSettings()

Returns the object with the settings used for calls to getTargetProject.

getUtilizationReportSettings()

public UnaryCallSettings<GetUtilizationReportRequest,UtilizationReport> getUtilizationReportSettings()

Returns the object with the settings used for calls to getUtilizationReport.

listCloneJobsSettings()

public PagedCallSettings<ListCloneJobsRequest,ListCloneJobsResponse,VmMigrationClient.ListCloneJobsPagedResponse> listCloneJobsSettings()

Returns the object with the settings used for calls to listCloneJobs.

listCutoverJobsSettings()

public PagedCallSettings<ListCutoverJobsRequest,ListCutoverJobsResponse,VmMigrationClient.ListCutoverJobsPagedResponse> listCutoverJobsSettings()

Returns the object with the settings used for calls to listCutoverJobs.

listDatacenterConnectorsSettings()

public PagedCallSettings<ListDatacenterConnectorsRequest,ListDatacenterConnectorsResponse,VmMigrationClient.ListDatacenterConnectorsPagedResponse> listDatacenterConnectorsSettings()

Returns the object with the settings used for calls to listDatacenterConnectors.

listGroupsSettings()

public PagedCallSettings<ListGroupsRequest,ListGroupsResponse,VmMigrationClient.ListGroupsPagedResponse> listGroupsSettings()

Returns the object with the settings used for calls to listGroups.

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,VmMigrationClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listMigratingVmsSettings()

public PagedCallSettings<ListMigratingVmsRequest,ListMigratingVmsResponse,VmMigrationClient.ListMigratingVmsPagedResponse> listMigratingVmsSettings()

Returns the object with the settings used for calls to listMigratingVms.

listReplicationCyclesSettings()

public PagedCallSettings<ListReplicationCyclesRequest,ListReplicationCyclesResponse,VmMigrationClient.ListReplicationCyclesPagedResponse> listReplicationCyclesSettings()

Returns the object with the settings used for calls to listReplicationCycles.

listSourcesSettings()

public PagedCallSettings<ListSourcesRequest,ListSourcesResponse,VmMigrationClient.ListSourcesPagedResponse> listSourcesSettings()

Returns the object with the settings used for calls to listSources.

listTargetProjectsSettings()

public PagedCallSettings<ListTargetProjectsRequest,ListTargetProjectsResponse,VmMigrationClient.ListTargetProjectsPagedResponse> listTargetProjectsSettings()

Returns the object with the settings used for calls to listTargetProjects.

listUtilizationReportsSettings()

public PagedCallSettings<ListUtilizationReportsRequest,ListUtilizationReportsResponse,VmMigrationClient.ListUtilizationReportsPagedResponse> listUtilizationReportsSettings()

Returns the object with the settings used for calls to listUtilizationReports.

pauseMigrationOperationSettings()

public OperationCallSettings<PauseMigrationRequest,PauseMigrationResponse,OperationMetadata> pauseMigrationOperationSettings()

Returns the object with the settings used for calls to pauseMigration.

pauseMigrationSettings()

public UnaryCallSettings<PauseMigrationRequest,Operation> pauseMigrationSettings()

Returns the object with the settings used for calls to pauseMigration.

removeGroupMigrationOperationSettings()

public OperationCallSettings<RemoveGroupMigrationRequest,RemoveGroupMigrationResponse,OperationMetadata> removeGroupMigrationOperationSettings()

Returns the object with the settings used for calls to removeGroupMigration.

removeGroupMigrationSettings()

public UnaryCallSettings<RemoveGroupMigrationRequest,Operation> removeGroupMigrationSettings()

Returns the object with the settings used for calls to removeGroupMigration.

resumeMigrationOperationSettings()

public OperationCallSettings<ResumeMigrationRequest,ResumeMigrationResponse,OperationMetadata> resumeMigrationOperationSettings()

Returns the object with the settings used for calls to resumeMigration.

resumeMigrationSettings()

public UnaryCallSettings<ResumeMigrationRequest,Operation> resumeMigrationSettings()

Returns the object with the settings used for calls to resumeMigration.

startMigrationOperationSettings()

public OperationCallSettings<StartMigrationRequest,StartMigrationResponse,OperationMetadata> startMigrationOperationSettings()

Returns the object with the settings used for calls to startMigration.

startMigrationSettings()

public UnaryCallSettings<StartMigrationRequest,Operation> startMigrationSettings()

Returns the object with the settings used for calls to startMigration.

toBuilder()

public VmMigrationSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
VmMigrationSettings.Builder
Overrides

updateGroupOperationSettings()

public OperationCallSettings<UpdateGroupRequest,Group,OperationMetadata> updateGroupOperationSettings()

Returns the object with the settings used for calls to updateGroup.

updateGroupSettings()

public UnaryCallSettings<UpdateGroupRequest,Operation> updateGroupSettings()

Returns the object with the settings used for calls to updateGroup.

Returns
Type Description
UnaryCallSettings<UpdateGroupRequest,Operation>

updateMigratingVmOperationSettings()

public OperationCallSettings<UpdateMigratingVmRequest,MigratingVm,OperationMetadata> updateMigratingVmOperationSettings()

Returns the object with the settings used for calls to updateMigratingVm.

updateMigratingVmSettings()

public UnaryCallSettings<UpdateMigratingVmRequest,Operation> updateMigratingVmSettings()

Returns the object with the settings used for calls to updateMigratingVm.

updateSourceOperationSettings()

public OperationCallSettings<UpdateSourceRequest,Source,OperationMetadata> updateSourceOperationSettings()

Returns the object with the settings used for calls to updateSource.

updateSourceSettings()

public UnaryCallSettings<UpdateSourceRequest,Operation> updateSourceSettings()

Returns the object with the settings used for calls to updateSource.

Returns
Type Description
UnaryCallSettings<UpdateSourceRequest,Operation>

updateTargetProjectOperationSettings()

public OperationCallSettings<UpdateTargetProjectRequest,TargetProject,OperationMetadata> updateTargetProjectOperationSettings()

Returns the object with the settings used for calls to updateTargetProject.

updateTargetProjectSettings()

public UnaryCallSettings<UpdateTargetProjectRequest,Operation> updateTargetProjectSettings()

Returns the object with the settings used for calls to updateTargetProject.

upgradeApplianceOperationSettings()

public OperationCallSettings<UpgradeApplianceRequest,UpgradeApplianceResponse,OperationMetadata> upgradeApplianceOperationSettings()

Returns the object with the settings used for calls to upgradeAppliance.

upgradeApplianceSettings()

public UnaryCallSettings<UpgradeApplianceRequest,Operation> upgradeApplianceSettings()

Returns the object with the settings used for calls to upgradeAppliance.