- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.8
- 2.1.9
public class DataMigrationServiceClient implements BackgroundResource
Service Description: Database Migration service
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
MigrationJobName name = MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]");
MigrationJob response = dataMigrationServiceClient.getMigrationJob(name);
}
Note: close() needs to be called on the DataMigrationServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataMigrationServiceSettings to create(). For example:
To customize credentials:
// 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
DataMigrationServiceSettings dataMigrationServiceSettings =
DataMigrationServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create(dataMigrationServiceSettings);
To customize the endpoint:
// 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
DataMigrationServiceSettings dataMigrationServiceSettings =
DataMigrationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create(dataMigrationServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final DataMigrationServiceClient create()
Constructs an instance of DataMigrationServiceClient with default settings.
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(DataMigrationServiceSettings settings)
public static final DataMigrationServiceClient create(DataMigrationServiceSettings settings)
Constructs an instance of DataMigrationServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings | DataMigrationServiceSettings |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(DataMigrationServiceStub stub)
public static final DataMigrationServiceClient create(DataMigrationServiceStub stub)
Constructs an instance of DataMigrationServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataMigrationServiceSettings).
Parameter | |
---|---|
Name | Description |
stub | DataMigrationServiceStub |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient |
Constructors
DataMigrationServiceClient(DataMigrationServiceSettings settings)
protected DataMigrationServiceClient(DataMigrationServiceSettings settings)
Constructs an instance of DataMigrationServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings | DataMigrationServiceSettings |
DataMigrationServiceClient(DataMigrationServiceStub stub)
protected DataMigrationServiceClient(DataMigrationServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | DataMigrationServiceStub |
Methods
applyConversionWorkspaceAsync(ApplyConversionWorkspaceRequest request)
public final OperationFuture<ConversionWorkspace,OperationMetadata> applyConversionWorkspaceAsync(ApplyConversionWorkspaceRequest request)
Applies draft tree onto a specific destination database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ApplyConversionWorkspaceRequest request =
ApplyConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setFilter("filter-1274492040")
.build();
ConversionWorkspace response =
dataMigrationServiceClient.applyConversionWorkspaceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | ApplyConversionWorkspaceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConversionWorkspace,OperationMetadata> |
applyConversionWorkspaceCallable()
public final UnaryCallable<ApplyConversionWorkspaceRequest,Operation> applyConversionWorkspaceCallable()
Applies draft tree onto a specific destination database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ApplyConversionWorkspaceRequest request =
ApplyConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setFilter("filter-1274492040")
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.applyConversionWorkspaceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ApplyConversionWorkspaceRequest,Operation> |
applyConversionWorkspaceOperationCallable()
public final OperationCallable<ApplyConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> applyConversionWorkspaceOperationCallable()
Applies draft tree onto a specific destination database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ApplyConversionWorkspaceRequest request =
ApplyConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setFilter("filter-1274492040")
.build();
OperationFuture<ConversionWorkspace, OperationMetadata> future =
dataMigrationServiceClient
.applyConversionWorkspaceOperationCallable()
.futureCall(request);
// Do something.
ConversionWorkspace response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ApplyConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
commitConversionWorkspaceAsync(CommitConversionWorkspaceRequest request)
public final OperationFuture<ConversionWorkspace,OperationMetadata> commitConversionWorkspaceAsync(CommitConversionWorkspaceRequest request)
Marks all the data in the conversion workspace as committed.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CommitConversionWorkspaceRequest request =
CommitConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setCommitName("commitName1018078306")
.build();
ConversionWorkspace response =
dataMigrationServiceClient.commitConversionWorkspaceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CommitConversionWorkspaceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConversionWorkspace,OperationMetadata> |
commitConversionWorkspaceCallable()
public final UnaryCallable<CommitConversionWorkspaceRequest,Operation> commitConversionWorkspaceCallable()
Marks all the data in the conversion workspace as committed.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CommitConversionWorkspaceRequest request =
CommitConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setCommitName("commitName1018078306")
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.commitConversionWorkspaceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CommitConversionWorkspaceRequest,Operation> |
commitConversionWorkspaceOperationCallable()
public final OperationCallable<CommitConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> commitConversionWorkspaceOperationCallable()
Marks all the data in the conversion workspace as committed.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CommitConversionWorkspaceRequest request =
CommitConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setCommitName("commitName1018078306")
.build();
OperationFuture<ConversionWorkspace, OperationMetadata> future =
dataMigrationServiceClient
.commitConversionWorkspaceOperationCallable()
.futureCall(request);
// Do something.
ConversionWorkspace response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CommitConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> |
convertConversionWorkspaceAsync(ConvertConversionWorkspaceRequest request)
public final OperationFuture<ConversionWorkspace,OperationMetadata> convertConversionWorkspaceAsync(ConvertConversionWorkspaceRequest request)
Creates a draft tree schema for the destination database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ConvertConversionWorkspaceRequest request =
ConvertConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setAutoCommit(true)
.setFilter("filter-1274492040")
.build();
ConversionWorkspace response =
dataMigrationServiceClient.convertConversionWorkspaceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | ConvertConversionWorkspaceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConversionWorkspace,OperationMetadata> |
convertConversionWorkspaceCallable()
public final UnaryCallable<ConvertConversionWorkspaceRequest,Operation> convertConversionWorkspaceCallable()
Creates a draft tree schema for the destination database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ConvertConversionWorkspaceRequest request =
ConvertConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setAutoCommit(true)
.setFilter("filter-1274492040")
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.convertConversionWorkspaceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ConvertConversionWorkspaceRequest,Operation> |
convertConversionWorkspaceOperationCallable()
public final OperationCallable<ConvertConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> convertConversionWorkspaceOperationCallable()
Creates a draft tree schema for the destination database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ConvertConversionWorkspaceRequest request =
ConvertConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setAutoCommit(true)
.setFilter("filter-1274492040")
.build();
OperationFuture<ConversionWorkspace, OperationMetadata> future =
dataMigrationServiceClient
.convertConversionWorkspaceOperationCallable()
.futureCall(request);
// Do something.
ConversionWorkspace response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ConvertConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> |
createConnectionProfileAsync(ConnectionProfileName parent, ConnectionProfile connectionProfile, String connectionProfileId)
public final OperationFuture<ConnectionProfile,OperationMetadata> createConnectionProfileAsync(ConnectionProfileName parent, ConnectionProfile connectionProfile, String connectionProfileId)
Creates a new connection profile in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ConnectionProfileName parent =
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]");
ConnectionProfile connectionProfile = ConnectionProfile.newBuilder().build();
String connectionProfileId = "connectionProfileId597575526";
ConnectionProfile response =
dataMigrationServiceClient
.createConnectionProfileAsync(parent, connectionProfile, connectionProfileId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent | ConnectionProfileName Required. The parent which owns this collection of connection profiles. |
connectionProfile | ConnectionProfile Required. The create request body including the connection profile data |
connectionProfileId | String Required. The connection profile identifier. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConnectionProfile,OperationMetadata> |
createConnectionProfileAsync(CreateConnectionProfileRequest request)
public final OperationFuture<ConnectionProfile,OperationMetadata> createConnectionProfileAsync(CreateConnectionProfileRequest request)
Creates a new connection profile in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateConnectionProfileRequest request =
CreateConnectionProfileRequest.newBuilder()
.setParent(
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]")
.toString())
.setConnectionProfileId("connectionProfileId597575526")
.setConnectionProfile(ConnectionProfile.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.setSkipValidation(true)
.build();
ConnectionProfile response =
dataMigrationServiceClient.createConnectionProfileAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateConnectionProfileRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConnectionProfile,OperationMetadata> |
createConnectionProfileAsync(String parent, ConnectionProfile connectionProfile, String connectionProfileId)
public final OperationFuture<ConnectionProfile,OperationMetadata> createConnectionProfileAsync(String parent, ConnectionProfile connectionProfile, String connectionProfileId)
Creates a new connection profile in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String parent =
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]").toString();
ConnectionProfile connectionProfile = ConnectionProfile.newBuilder().build();
String connectionProfileId = "connectionProfileId597575526";
ConnectionProfile response =
dataMigrationServiceClient
.createConnectionProfileAsync(parent, connectionProfile, connectionProfileId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent which owns this collection of connection profiles. |
connectionProfile | ConnectionProfile Required. The create request body including the connection profile data |
connectionProfileId | String Required. The connection profile identifier. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConnectionProfile,OperationMetadata> |
createConnectionProfileCallable()
public final UnaryCallable<CreateConnectionProfileRequest,Operation> createConnectionProfileCallable()
Creates a new connection profile in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateConnectionProfileRequest request =
CreateConnectionProfileRequest.newBuilder()
.setParent(
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]")
.toString())
.setConnectionProfileId("connectionProfileId597575526")
.setConnectionProfile(ConnectionProfile.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.setSkipValidation(true)
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.createConnectionProfileCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateConnectionProfileRequest,Operation> |
createConnectionProfileOperationCallable()
public final OperationCallable<CreateConnectionProfileRequest,ConnectionProfile,OperationMetadata> createConnectionProfileOperationCallable()
Creates a new connection profile in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateConnectionProfileRequest request =
CreateConnectionProfileRequest.newBuilder()
.setParent(
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]")
.toString())
.setConnectionProfileId("connectionProfileId597575526")
.setConnectionProfile(ConnectionProfile.newBuilder().build())
.setRequestId("requestId693933066")
.setValidateOnly(true)
.setSkipValidation(true)
.build();
OperationFuture<ConnectionProfile, OperationMetadata> future =
dataMigrationServiceClient.createConnectionProfileOperationCallable().futureCall(request);
// Do something.
ConnectionProfile response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateConnectionProfileRequest,ConnectionProfile,OperationMetadata> |
createConversionWorkspaceAsync(CreateConversionWorkspaceRequest request)
public final OperationFuture<ConversionWorkspace,OperationMetadata> createConversionWorkspaceAsync(CreateConversionWorkspaceRequest request)
Creates a new conversion workspace in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateConversionWorkspaceRequest request =
CreateConversionWorkspaceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setConversionWorkspaceId("conversionWorkspaceId-928604774")
.setConversionWorkspace(ConversionWorkspace.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ConversionWorkspace response =
dataMigrationServiceClient.createConversionWorkspaceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateConversionWorkspaceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConversionWorkspace,OperationMetadata> |
createConversionWorkspaceAsync(LocationName parent, ConversionWorkspace conversionWorkspace, String conversionWorkspaceId)
public final OperationFuture<ConversionWorkspace,OperationMetadata> createConversionWorkspaceAsync(LocationName parent, ConversionWorkspace conversionWorkspace, String conversionWorkspaceId)
Creates a new conversion workspace in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
ConversionWorkspace conversionWorkspace = ConversionWorkspace.newBuilder().build();
String conversionWorkspaceId = "conversionWorkspaceId-928604774";
ConversionWorkspace response =
dataMigrationServiceClient
.createConversionWorkspaceAsync(parent, conversionWorkspace, conversionWorkspaceId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent which owns this collection of conversion workspaces. |
conversionWorkspace | ConversionWorkspace Required. Represents a conversion workspace object. |
conversionWorkspaceId | String Required. The ID of the conversion workspace to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConversionWorkspace,OperationMetadata> |
createConversionWorkspaceAsync(String parent, ConversionWorkspace conversionWorkspace, String conversionWorkspaceId)
public final OperationFuture<ConversionWorkspace,OperationMetadata> createConversionWorkspaceAsync(String parent, ConversionWorkspace conversionWorkspace, String conversionWorkspaceId)
Creates a new conversion workspace in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
ConversionWorkspace conversionWorkspace = ConversionWorkspace.newBuilder().build();
String conversionWorkspaceId = "conversionWorkspaceId-928604774";
ConversionWorkspace response =
dataMigrationServiceClient
.createConversionWorkspaceAsync(parent, conversionWorkspace, conversionWorkspaceId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent which owns this collection of conversion workspaces. |
conversionWorkspace | ConversionWorkspace Required. Represents a conversion workspace object. |
conversionWorkspaceId | String Required. The ID of the conversion workspace to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<ConversionWorkspace,OperationMetadata> |
createConversionWorkspaceCallable()
public final UnaryCallable<CreateConversionWorkspaceRequest,Operation> createConversionWorkspaceCallable()
Creates a new conversion workspace in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateConversionWorkspaceRequest request =
CreateConversionWorkspaceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setConversionWorkspaceId("conversionWorkspaceId-928604774")
.setConversionWorkspace(ConversionWorkspace.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.createConversionWorkspaceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateConversionWorkspaceRequest,Operation> |
createConversionWorkspaceOperationCallable()
public final OperationCallable<CreateConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> createConversionWorkspaceOperationCallable()
Creates a new conversion workspace in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateConversionWorkspaceRequest request =
CreateConversionWorkspaceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setConversionWorkspaceId("conversionWorkspaceId-928604774")
.setConversionWorkspace(ConversionWorkspace.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<ConversionWorkspace, OperationMetadata> future =
dataMigrationServiceClient
.createConversionWorkspaceOperationCallable()
.futureCall(request);
// Do something.
ConversionWorkspace response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateConversionWorkspaceRequest,ConversionWorkspace,OperationMetadata> |
createMigrationJobAsync(CreateMigrationJobRequest request)
public final OperationFuture<MigrationJob,OperationMetadata> createMigrationJobAsync(CreateMigrationJobRequest request)
Creates a new migration job in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateMigrationJobRequest request =
CreateMigrationJobRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setMigrationJobId("migrationJobId1870575242")
.setMigrationJob(MigrationJob.newBuilder().build())
.setRequestId("requestId693933066")
.build();
MigrationJob response = dataMigrationServiceClient.createMigrationJobAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateMigrationJobRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<MigrationJob,OperationMetadata> |
createMigrationJobAsync(LocationName parent, MigrationJob migrationJob, String migrationJobId)
public final OperationFuture<MigrationJob,OperationMetadata> createMigrationJobAsync(LocationName parent, MigrationJob migrationJob, String migrationJobId)
Creates a new migration job in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
MigrationJob migrationJob = MigrationJob.newBuilder().build();
String migrationJobId = "migrationJobId1870575242";
MigrationJob response =
dataMigrationServiceClient
.createMigrationJobAsync(parent, migrationJob, migrationJobId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent which owns this collection of migration jobs. |
migrationJob | MigrationJob Required. Represents a migration job object. |
migrationJobId | String Required. The ID of the instance to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<MigrationJob,OperationMetadata> |
createMigrationJobAsync(String parent, MigrationJob migrationJob, String migrationJobId)
public final OperationFuture<MigrationJob,OperationMetadata> createMigrationJobAsync(String parent, MigrationJob migrationJob, String migrationJobId)
Creates a new migration job in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
MigrationJob migrationJob = MigrationJob.newBuilder().build();
String migrationJobId = "migrationJobId1870575242";
MigrationJob response =
dataMigrationServiceClient
.createMigrationJobAsync(parent, migrationJob, migrationJobId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent which owns this collection of migration jobs. |
migrationJob | MigrationJob Required. Represents a migration job object. |
migrationJobId | String Required. The ID of the instance to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<MigrationJob,OperationMetadata> |
createMigrationJobCallable()
public final UnaryCallable<CreateMigrationJobRequest,Operation> createMigrationJobCallable()
Creates a new migration job in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateMigrationJobRequest request =
CreateMigrationJobRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setMigrationJobId("migrationJobId1870575242")
.setMigrationJob(MigrationJob.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.createMigrationJobCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateMigrationJobRequest,Operation> |
createMigrationJobOperationCallable()
public final OperationCallable<CreateMigrationJobRequest,MigrationJob,OperationMetadata> createMigrationJobOperationCallable()
Creates a new migration job in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreateMigrationJobRequest request =
CreateMigrationJobRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setMigrationJobId("migrationJobId1870575242")
.setMigrationJob(MigrationJob.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<MigrationJob, OperationMetadata> future =
dataMigrationServiceClient.createMigrationJobOperationCallable().futureCall(request);
// Do something.
MigrationJob response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateMigrationJobRequest,MigrationJob,OperationMetadata> |
createPrivateConnectionAsync(CreatePrivateConnectionRequest request)
public final OperationFuture<PrivateConnection,OperationMetadata> createPrivateConnectionAsync(CreatePrivateConnectionRequest request)
Creates a new private connection in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreatePrivateConnectionRequest request =
CreatePrivateConnectionRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPrivateConnectionId("privateConnectionId-1926654532")
.setPrivateConnection(PrivateConnection.newBuilder().build())
.setRequestId("requestId693933066")
.setSkipValidation(true)
.build();
PrivateConnection response =
dataMigrationServiceClient.createPrivateConnectionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreatePrivateConnectionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<PrivateConnection,OperationMetadata> |
createPrivateConnectionAsync(LocationName parent, PrivateConnection privateConnection, String privateConnectionId)
public final OperationFuture<PrivateConnection,OperationMetadata> createPrivateConnectionAsync(LocationName parent, PrivateConnection privateConnection, String privateConnectionId)
Creates a new private connection in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
PrivateConnection privateConnection = PrivateConnection.newBuilder().build();
String privateConnectionId = "privateConnectionId-1926654532";
PrivateConnection response =
dataMigrationServiceClient
.createPrivateConnectionAsync(parent, privateConnection, privateConnectionId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent that owns the collection of PrivateConnections. |
privateConnection | PrivateConnection Required. The private connection resource to create. |
privateConnectionId | String Required. The private connection identifier. |
Returns | |
---|---|
Type | Description |
OperationFuture<PrivateConnection,OperationMetadata> |
createPrivateConnectionAsync(String parent, PrivateConnection privateConnection, String privateConnectionId)
public final OperationFuture<PrivateConnection,OperationMetadata> createPrivateConnectionAsync(String parent, PrivateConnection privateConnection, String privateConnectionId)
Creates a new private connection in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
PrivateConnection privateConnection = PrivateConnection.newBuilder().build();
String privateConnectionId = "privateConnectionId-1926654532";
PrivateConnection response =
dataMigrationServiceClient
.createPrivateConnectionAsync(parent, privateConnection, privateConnectionId)
.get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent that owns the collection of PrivateConnections. |
privateConnection | PrivateConnection Required. The private connection resource to create. |
privateConnectionId | String Required. The private connection identifier. |
Returns | |
---|---|
Type | Description |
OperationFuture<PrivateConnection,OperationMetadata> |
createPrivateConnectionCallable()
public final UnaryCallable<CreatePrivateConnectionRequest,Operation> createPrivateConnectionCallable()
Creates a new private connection in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreatePrivateConnectionRequest request =
CreatePrivateConnectionRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPrivateConnectionId("privateConnectionId-1926654532")
.setPrivateConnection(PrivateConnection.newBuilder().build())
.setRequestId("requestId693933066")
.setSkipValidation(true)
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.createPrivateConnectionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreatePrivateConnectionRequest,Operation> |
createPrivateConnectionOperationCallable()
public final OperationCallable<CreatePrivateConnectionRequest,PrivateConnection,OperationMetadata> createPrivateConnectionOperationCallable()
Creates a new private connection in a given project and location.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
CreatePrivateConnectionRequest request =
CreatePrivateConnectionRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPrivateConnectionId("privateConnectionId-1926654532")
.setPrivateConnection(PrivateConnection.newBuilder().build())
.setRequestId("requestId693933066")
.setSkipValidation(true)
.build();
OperationFuture<PrivateConnection, OperationMetadata> future =
dataMigrationServiceClient.createPrivateConnectionOperationCallable().futureCall(request);
// Do something.
PrivateConnection response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreatePrivateConnectionRequest,PrivateConnection,OperationMetadata> |
deleteConnectionProfileAsync(ConnectionProfileName name)
public final OperationFuture<Empty,OperationMetadata> deleteConnectionProfileAsync(ConnectionProfileName name)
Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ConnectionProfileName name =
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]");
dataMigrationServiceClient.deleteConnectionProfileAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | ConnectionProfileName Required. Name of the connection profile resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteConnectionProfileAsync(DeleteConnectionProfileRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteConnectionProfileAsync(DeleteConnectionProfileRequest request)
Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteConnectionProfileRequest request =
DeleteConnectionProfileRequest.newBuilder()
.setName(
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]")
.toString())
.setRequestId("requestId693933066")
.setForce(true)
.build();
dataMigrationServiceClient.deleteConnectionProfileAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteConnectionProfileRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteConnectionProfileAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteConnectionProfileAsync(String name)
Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String name =
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]").toString();
dataMigrationServiceClient.deleteConnectionProfileAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. Name of the connection profile resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteConnectionProfileCallable()
public final UnaryCallable<DeleteConnectionProfileRequest,Operation> deleteConnectionProfileCallable()
Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteConnectionProfileRequest request =
DeleteConnectionProfileRequest.newBuilder()
.setName(
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]")
.toString())
.setRequestId("requestId693933066")
.setForce(true)
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.deleteConnectionProfileCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteConnectionProfileRequest,Operation> |
deleteConnectionProfileOperationCallable()
public final OperationCallable<DeleteConnectionProfileRequest,Empty,OperationMetadata> deleteConnectionProfileOperationCallable()
Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteConnectionProfileRequest request =
DeleteConnectionProfileRequest.newBuilder()
.setName(
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]")
.toString())
.setRequestId("requestId693933066")
.setForce(true)
.build();
OperationFuture<Empty, OperationMetadata> future =
dataMigrationServiceClient.deleteConnectionProfileOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteConnectionProfileRequest,Empty,OperationMetadata> |
deleteConversionWorkspaceAsync(ConversionWorkspaceName name)
public final OperationFuture<Empty,OperationMetadata> deleteConversionWorkspaceAsync(ConversionWorkspaceName name)
Deletes a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ConversionWorkspaceName name =
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]");
dataMigrationServiceClient.deleteConversionWorkspaceAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | ConversionWorkspaceName Required. Name of the conversion workspace resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteConversionWorkspaceAsync(DeleteConversionWorkspaceRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteConversionWorkspaceAsync(DeleteConversionWorkspaceRequest request)
Deletes a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteConversionWorkspaceRequest request =
DeleteConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setRequestId("requestId693933066")
.build();
dataMigrationServiceClient.deleteConversionWorkspaceAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteConversionWorkspaceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteConversionWorkspaceAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteConversionWorkspaceAsync(String name)
Deletes a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String name =
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString();
dataMigrationServiceClient.deleteConversionWorkspaceAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. Name of the conversion workspace resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteConversionWorkspaceCallable()
public final UnaryCallable<DeleteConversionWorkspaceRequest,Operation> deleteConversionWorkspaceCallable()
Deletes a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteConversionWorkspaceRequest request =
DeleteConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.deleteConversionWorkspaceCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteConversionWorkspaceRequest,Operation> |
deleteConversionWorkspaceOperationCallable()
public final OperationCallable<DeleteConversionWorkspaceRequest,Empty,OperationMetadata> deleteConversionWorkspaceOperationCallable()
Deletes a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteConversionWorkspaceRequest request =
DeleteConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
dataMigrationServiceClient
.deleteConversionWorkspaceOperationCallable()
.futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteConversionWorkspaceRequest,Empty,OperationMetadata> |
deleteMigrationJobAsync(DeleteMigrationJobRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteMigrationJobAsync(DeleteMigrationJobRequest request)
Deletes a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteMigrationJobRequest request =
DeleteMigrationJobRequest.newBuilder()
.setName(MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString())
.setRequestId("requestId693933066")
.setForce(true)
.build();
dataMigrationServiceClient.deleteMigrationJobAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteMigrationJobRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteMigrationJobAsync(MigrationJobName name)
public final OperationFuture<Empty,OperationMetadata> deleteMigrationJobAsync(MigrationJobName name)
Deletes a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
MigrationJobName name = MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]");
dataMigrationServiceClient.deleteMigrationJobAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | MigrationJobName Required. Name of the migration job resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteMigrationJobAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteMigrationJobAsync(String name)
Deletes a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String name = MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString();
dataMigrationServiceClient.deleteMigrationJobAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. Name of the migration job resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteMigrationJobCallable()
public final UnaryCallable<DeleteMigrationJobRequest,Operation> deleteMigrationJobCallable()
Deletes a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteMigrationJobRequest request =
DeleteMigrationJobRequest.newBuilder()
.setName(MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString())
.setRequestId("requestId693933066")
.setForce(true)
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.deleteMigrationJobCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteMigrationJobRequest,Operation> |
deleteMigrationJobOperationCallable()
public final OperationCallable<DeleteMigrationJobRequest,Empty,OperationMetadata> deleteMigrationJobOperationCallable()
Deletes a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeleteMigrationJobRequest request =
DeleteMigrationJobRequest.newBuilder()
.setName(MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString())
.setRequestId("requestId693933066")
.setForce(true)
.build();
OperationFuture<Empty, OperationMetadata> future =
dataMigrationServiceClient.deleteMigrationJobOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteMigrationJobRequest,Empty,OperationMetadata> |
deletePrivateConnectionAsync(DeletePrivateConnectionRequest request)
public final OperationFuture<Empty,OperationMetadata> deletePrivateConnectionAsync(DeletePrivateConnectionRequest request)
Deletes a single Database Migration Service private connection.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeletePrivateConnectionRequest request =
DeletePrivateConnectionRequest.newBuilder()
.setName(
PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
.toString())
.setRequestId("requestId693933066")
.build();
dataMigrationServiceClient.deletePrivateConnectionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeletePrivateConnectionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePrivateConnectionAsync(PrivateConnectionName name)
public final OperationFuture<Empty,OperationMetadata> deletePrivateConnectionAsync(PrivateConnectionName name)
Deletes a single Database Migration Service private connection.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
PrivateConnectionName name =
PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]");
dataMigrationServiceClient.deletePrivateConnectionAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | PrivateConnectionName Required. The name of the private connection to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePrivateConnectionAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deletePrivateConnectionAsync(String name)
Deletes a single Database Migration Service private connection.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String name =
PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]").toString();
dataMigrationServiceClient.deletePrivateConnectionAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The name of the private connection to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deletePrivateConnectionCallable()
public final UnaryCallable<DeletePrivateConnectionRequest,Operation> deletePrivateConnectionCallable()
Deletes a single Database Migration Service private connection.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeletePrivateConnectionRequest request =
DeletePrivateConnectionRequest.newBuilder()
.setName(
PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
.toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataMigrationServiceClient.deletePrivateConnectionCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeletePrivateConnectionRequest,Operation> |
deletePrivateConnectionOperationCallable()
public final OperationCallable<DeletePrivateConnectionRequest,Empty,OperationMetadata> deletePrivateConnectionOperationCallable()
Deletes a single Database Migration Service private connection.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DeletePrivateConnectionRequest request =
DeletePrivateConnectionRequest.newBuilder()
.setName(
PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
.toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
dataMigrationServiceClient.deletePrivateConnectionOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeletePrivateConnectionRequest,Empty,OperationMetadata> |
describeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request)
public final DescribeConversionWorkspaceRevisionsResponse describeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request)
Retrieves a list of committed revisions of a specific conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DescribeConversionWorkspaceRevisionsRequest request =
DescribeConversionWorkspaceRevisionsRequest.newBuilder()
.setConversionWorkspace(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setCommitId("commitId-602292046")
.build();
DescribeConversionWorkspaceRevisionsResponse response =
dataMigrationServiceClient.describeConversionWorkspaceRevisions(request);
}
Parameter | |
---|---|
Name | Description |
request | DescribeConversionWorkspaceRevisionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DescribeConversionWorkspaceRevisionsResponse |
describeConversionWorkspaceRevisionsCallable()
public final UnaryCallable<DescribeConversionWorkspaceRevisionsRequest,DescribeConversionWorkspaceRevisionsResponse> describeConversionWorkspaceRevisionsCallable()
Retrieves a list of committed revisions of a specific conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DescribeConversionWorkspaceRevisionsRequest request =
DescribeConversionWorkspaceRevisionsRequest.newBuilder()
.setConversionWorkspace(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setCommitId("commitId-602292046")
.build();
ApiFuture<DescribeConversionWorkspaceRevisionsResponse> future =
dataMigrationServiceClient
.describeConversionWorkspaceRevisionsCallable()
.futureCall(request);
// Do something.
DescribeConversionWorkspaceRevisionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DescribeConversionWorkspaceRevisionsRequest,DescribeConversionWorkspaceRevisionsResponse> |
describeDatabaseEntities(DescribeDatabaseEntitiesRequest request)
public final DataMigrationServiceClient.DescribeDatabaseEntitiesPagedResponse describeDatabaseEntities(DescribeDatabaseEntitiesRequest request)
Describes the database entities tree for a specific conversion workspace and a specific tree type.
Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DescribeDatabaseEntitiesRequest request =
DescribeDatabaseEntitiesRequest.newBuilder()
.setConversionWorkspace(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setUncommitted(true)
.setCommitId("commitId-602292046")
.setFilter("filter-1274492040")
.build();
for (DatabaseEntity element :
dataMigrationServiceClient.describeDatabaseEntities(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | DescribeDatabaseEntitiesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient.DescribeDatabaseEntitiesPagedResponse |
describeDatabaseEntitiesCallable()
public final UnaryCallable<DescribeDatabaseEntitiesRequest,DescribeDatabaseEntitiesResponse> describeDatabaseEntitiesCallable()
Describes the database entities tree for a specific conversion workspace and a specific tree type.
Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DescribeDatabaseEntitiesRequest request =
DescribeDatabaseEntitiesRequest.newBuilder()
.setConversionWorkspace(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setUncommitted(true)
.setCommitId("commitId-602292046")
.setFilter("filter-1274492040")
.build();
while (true) {
DescribeDatabaseEntitiesResponse response =
dataMigrationServiceClient.describeDatabaseEntitiesCallable().call(request);
for (DatabaseEntity element : response.getDatabaseEntitiesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DescribeDatabaseEntitiesRequest,DescribeDatabaseEntitiesResponse> |
describeDatabaseEntitiesPagedCallable()
public final UnaryCallable<DescribeDatabaseEntitiesRequest,DataMigrationServiceClient.DescribeDatabaseEntitiesPagedResponse> describeDatabaseEntitiesPagedCallable()
Describes the database entities tree for a specific conversion workspace and a specific tree type.
Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
DescribeDatabaseEntitiesRequest request =
DescribeDatabaseEntitiesRequest.newBuilder()
.setConversionWorkspace(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setUncommitted(true)
.setCommitId("commitId-602292046")
.setFilter("filter-1274492040")
.build();
ApiFuture<DatabaseEntity> future =
dataMigrationServiceClient.describeDatabaseEntitiesPagedCallable().futureCall(request);
// Do something.
for (DatabaseEntity element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DescribeDatabaseEntitiesRequest,DescribeDatabaseEntitiesPagedResponse> |
fetchStaticIps(FetchStaticIpsRequest request)
public final DataMigrationServiceClient.FetchStaticIpsPagedResponse fetchStaticIps(FetchStaticIpsRequest request)
Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
FetchStaticIpsRequest request =
FetchStaticIpsRequest.newBuilder()
.setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (String element : dataMigrationServiceClient.fetchStaticIps(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | FetchStaticIpsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient.FetchStaticIpsPagedResponse |
fetchStaticIps(LocationName name)
public final DataMigrationServiceClient.FetchStaticIpsPagedResponse fetchStaticIps(LocationName name)
Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
LocationName name = LocationName.of("[PROJECT]", "[LOCATION]");
for (String element : dataMigrationServiceClient.fetchStaticIps(name).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
name | LocationName Required. The resource name for the location for which static IPs should be
returned. Must be in the format |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient.FetchStaticIpsPagedResponse |
fetchStaticIps(String name)
public final DataMigrationServiceClient.FetchStaticIpsPagedResponse fetchStaticIps(String name)
Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String name = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (String element : dataMigrationServiceClient.fetchStaticIps(name).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
name | String Required. The resource name for the location for which static IPs should be
returned. Must be in the format |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient.FetchStaticIpsPagedResponse |
fetchStaticIpsCallable()
public final UnaryCallable<FetchStaticIpsRequest,FetchStaticIpsResponse> fetchStaticIpsCallable()
Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
FetchStaticIpsRequest request =
FetchStaticIpsRequest.newBuilder()
.setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
FetchStaticIpsResponse response =
dataMigrationServiceClient.fetchStaticIpsCallable().call(request);
for (String element : response.getStaticIpsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<FetchStaticIpsRequest,FetchStaticIpsResponse> |
fetchStaticIpsPagedCallable()
public final UnaryCallable<FetchStaticIpsRequest,DataMigrationServiceClient.FetchStaticIpsPagedResponse> fetchStaticIpsPagedCallable()
Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
FetchStaticIpsRequest request =
FetchStaticIpsRequest.newBuilder()
.setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<String> future =
dataMigrationServiceClient.fetchStaticIpsPagedCallable().futureCall(request);
// Do something.
for (String element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<FetchStaticIpsRequest,FetchStaticIpsPagedResponse> |
generateSshScript(GenerateSshScriptRequest request)
public final SshScript generateSshScript(GenerateSshScriptRequest request)
Generate a SSH configuration script to configure the reverse SSH connectivity.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GenerateSshScriptRequest request =
GenerateSshScriptRequest.newBuilder()
.setMigrationJob(
MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString())
.setVm("vm3767")
.setVmPort(563010825)
.build();
SshScript response = dataMigrationServiceClient.generateSshScript(request);
}
Parameter | |
---|---|
Name | Description |
request | GenerateSshScriptRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
SshScript |
generateSshScriptCallable()
public final UnaryCallable<GenerateSshScriptRequest,SshScript> generateSshScriptCallable()
Generate a SSH configuration script to configure the reverse SSH connectivity.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GenerateSshScriptRequest request =
GenerateSshScriptRequest.newBuilder()
.setMigrationJob(
MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString())
.setVm("vm3767")
.setVmPort(563010825)
.build();
ApiFuture<SshScript> future =
dataMigrationServiceClient.generateSshScriptCallable().futureCall(request);
// Do something.
SshScript response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GenerateSshScriptRequest,SshScript> |
getConnectionProfile(ConnectionProfileName name)
public final ConnectionProfile getConnectionProfile(ConnectionProfileName name)
Gets details of a single connection profile.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ConnectionProfileName name =
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]");
ConnectionProfile response = dataMigrationServiceClient.getConnectionProfile(name);
}
Parameter | |
---|---|
Name | Description |
name | ConnectionProfileName Required. Name of the connection profile resource to get. |
Returns | |
---|---|
Type | Description |
ConnectionProfile |
getConnectionProfile(GetConnectionProfileRequest request)
public final ConnectionProfile getConnectionProfile(GetConnectionProfileRequest request)
Gets details of a single connection profile.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GetConnectionProfileRequest request =
GetConnectionProfileRequest.newBuilder()
.setName(
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]")
.toString())
.build();
ConnectionProfile response = dataMigrationServiceClient.getConnectionProfile(request);
}
Parameter | |
---|---|
Name | Description |
request | GetConnectionProfileRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ConnectionProfile |
getConnectionProfile(String name)
public final ConnectionProfile getConnectionProfile(String name)
Gets details of a single connection profile.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String name =
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]").toString();
ConnectionProfile response = dataMigrationServiceClient.getConnectionProfile(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. Name of the connection profile resource to get. |
Returns | |
---|---|
Type | Description |
ConnectionProfile |
getConnectionProfileCallable()
public final UnaryCallable<GetConnectionProfileRequest,ConnectionProfile> getConnectionProfileCallable()
Gets details of a single connection profile.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GetConnectionProfileRequest request =
GetConnectionProfileRequest.newBuilder()
.setName(
ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]")
.toString())
.build();
ApiFuture<ConnectionProfile> future =
dataMigrationServiceClient.getConnectionProfileCallable().futureCall(request);
// Do something.
ConnectionProfile response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetConnectionProfileRequest,ConnectionProfile> |
getConversionWorkspace(ConversionWorkspaceName name)
public final ConversionWorkspace getConversionWorkspace(ConversionWorkspaceName name)
Gets details of a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
ConversionWorkspaceName name =
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]");
ConversionWorkspace response = dataMigrationServiceClient.getConversionWorkspace(name);
}
Parameter | |
---|---|
Name | Description |
name | ConversionWorkspaceName Required. Name of the conversion workspace resource to get. |
Returns | |
---|---|
Type | Description |
ConversionWorkspace |
getConversionWorkspace(GetConversionWorkspaceRequest request)
public final ConversionWorkspace getConversionWorkspace(GetConversionWorkspaceRequest request)
Gets details of a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GetConversionWorkspaceRequest request =
GetConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.build();
ConversionWorkspace response = dataMigrationServiceClient.getConversionWorkspace(request);
}
Parameter | |
---|---|
Name | Description |
request | GetConversionWorkspaceRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ConversionWorkspace |
getConversionWorkspace(String name)
public final ConversionWorkspace getConversionWorkspace(String name)
Gets details of a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String name =
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString();
ConversionWorkspace response = dataMigrationServiceClient.getConversionWorkspace(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. Name of the conversion workspace resource to get. |
Returns | |
---|---|
Type | Description |
ConversionWorkspace |
getConversionWorkspaceCallable()
public final UnaryCallable<GetConversionWorkspaceRequest,ConversionWorkspace> getConversionWorkspaceCallable()
Gets details of a single conversion workspace.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GetConversionWorkspaceRequest request =
GetConversionWorkspaceRequest.newBuilder()
.setName(
ConversionWorkspaceName.of("[PROJECT]", "[LOCATION]", "[CONVERSION_WORKSPACE]")
.toString())
.build();
ApiFuture<ConversionWorkspace> future =
dataMigrationServiceClient.getConversionWorkspaceCallable().futureCall(request);
// Do something.
ConversionWorkspace response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetConversionWorkspaceRequest,ConversionWorkspace> |
getMigrationJob(GetMigrationJobRequest request)
public final MigrationJob getMigrationJob(GetMigrationJobRequest request)
Gets details of a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GetMigrationJobRequest request =
GetMigrationJobRequest.newBuilder()
.setName(MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString())
.build();
MigrationJob response = dataMigrationServiceClient.getMigrationJob(request);
}
Parameter | |
---|---|
Name | Description |
request | GetMigrationJobRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
MigrationJob |
getMigrationJob(MigrationJobName name)
public final MigrationJob getMigrationJob(MigrationJobName name)
Gets details of a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
MigrationJobName name = MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]");
MigrationJob response = dataMigrationServiceClient.getMigrationJob(name);
}
Parameter | |
---|---|
Name | Description |
name | MigrationJobName Required. Name of the migration job resource to get. |
Returns | |
---|---|
Type | Description |
MigrationJob |
getMigrationJob(String name)
public final MigrationJob getMigrationJob(String name)
Gets details of a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
String name = MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString();
MigrationJob response = dataMigrationServiceClient.getMigrationJob(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. Name of the migration job resource to get. |
Returns | |
---|---|
Type | Description |
MigrationJob |
getMigrationJobCallable()
public final UnaryCallable<GetMigrationJobRequest,MigrationJob> getMigrationJobCallable()
Gets details of a single migration job.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GetMigrationJobRequest request =
GetMigrationJobRequest.newBuilder()
.setName(MigrationJobName.of("[PROJECT]", "[LOCATION]", "[MIGRATION_JOB]").toString())
.build();
ApiFuture<MigrationJob> future =
dataMigrationServiceClient.getMigrationJobCallable().futureCall(request);
// Do something.
MigrationJob response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetMigrationJobRequest,MigrationJob> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getPrivateConnection(GetPrivateConnectionRequest request)
public final PrivateConnection getPrivateConnection(GetPrivateConnectionRequest request)
Gets details of a single private connection.
Sample code:
// 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
try (DataMigrationServiceClient dataMigrationServiceClient =
DataMigrationServiceClient.create()) {
GetPrivateConnectionRequest request =
GetPrivateConnectionRequest.newBuilder()
.setName(
PrivateConnectionName.of("[PROJECT]", "[LOCATION]", "[PRIVATE_CONNECTION]")
.toString())
.build();
PrivateConnection response = dataMigrationServiceClient.getPrivateConnection(request);
}
Parameter | |
---|---|
Name | Description |
request | GetPrivateConnectionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PrivateConnection |
getPrivateConnection(PrivateConnectionName name)
public final PrivateConnection getPrivateConnection(PrivateConnectionName name)
Gets details of a single private connection.
Sample code:
// This snippet has been automatically generated and should be rega