com.google.storagetransfer.v1.proto.StorageTransferServiceClient Maven / Gradle / Ivy
Show all versions of google-cloud-storage-transfer Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.storagetransfer.v1.proto;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import com.google.storagetransfer.v1.proto.stub.StorageTransferServiceStub;
import com.google.storagetransfer.v1.proto.stub.StorageTransferServiceStubSettings;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Storage Transfer Service and its protos. Transfers data between between
* Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.
*
* 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:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.GetGoogleServiceAccountRequest request =
* TransferProto.GetGoogleServiceAccountRequest.newBuilder()
* .setProjectId("projectId-894832108")
* .build();
* TransferTypes.GoogleServiceAccount response =
* storageTransferServiceClient.getGoogleServiceAccount(request);
* }
* }
*
* Note: close() needs to be called on the StorageTransferServiceClient object to clean up
* resources such as threads. In the example above, try-with-resources is used, which automatically
* calls close().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* GetGoogleServiceAccount
Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getGoogleServiceAccount(TransferProto.GetGoogleServiceAccountRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getGoogleServiceAccountCallable()
*
*
*
*
* CreateTransferJob
Creates a transfer job that runs periodically.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createTransferJob(TransferProto.CreateTransferJobRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createTransferJobCallable()
*
*
*
*
* UpdateTransferJob
Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already.
*
**Note:** The job's [status][google.storagetransfer.v1.TransferJob.status] field can be modified using this RPC (for example, to set a job's status to [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED], [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], or [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED]).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateTransferJob(TransferProto.UpdateTransferJobRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateTransferJobCallable()
*
*
*
*
* GetTransferJob
Gets a transfer job.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getTransferJob(TransferProto.GetTransferJobRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getTransferJobCallable()
*
*
*
*
* ListTransferJobs
Lists transfer jobs.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listTransferJobs(TransferProto.ListTransferJobsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listTransferJobsPagedCallable()
*
listTransferJobsCallable()
*
*
*
*
* PauseTransferOperation
Pauses a transfer operation.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* pauseTransferOperationCallable()
*
*
*
*
* ResumeTransferOperation
Resumes a transfer operation that is paused.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* resumeTransferOperationCallable()
*
*
*
*
* RunTransferJob
Starts a new operation for the specified transfer job. A `TransferJob` has a maximum of one active `TransferOperation`. If this method is called while a `TransferOperation` is active, an error is returned.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* runTransferJobAsync(TransferProto.RunTransferJobRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* runTransferJobOperationCallable()
*
runTransferJobCallable()
*
*
*
*
* DeleteTransferJob
Deletes a transfer job. Deleting a transfer job sets its status to [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteTransferJob(TransferProto.DeleteTransferJobRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteTransferJobCallable()
*
*
*
*
* CreateAgentPool
Creates an agent pool resource.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createAgentPool(TransferProto.CreateAgentPoolRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createAgentPool(String projectId, TransferTypes.AgentPool agentPool, String agentPoolId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createAgentPoolCallable()
*
*
*
*
* UpdateAgentPool
Updates an existing agent pool resource.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateAgentPool(TransferProto.UpdateAgentPoolRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateAgentPool(TransferTypes.AgentPool agentPool, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateAgentPoolCallable()
*
*
*
*
* GetAgentPool
Gets an agent pool.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getAgentPool(TransferProto.GetAgentPoolRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getAgentPool(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getAgentPoolCallable()
*
*
*
*
* ListAgentPools
Lists agent pools.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listAgentPools(TransferProto.ListAgentPoolsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listAgentPools(String projectId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listAgentPoolsPagedCallable()
*
listAgentPoolsCallable()
*
*
*
*
* DeleteAgentPool
Deletes an agent pool.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteAgentPool(TransferProto.DeleteAgentPoolRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteAgentPool(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteAgentPoolCallable()
*
*
*
*
*
* 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 StorageTransferServiceSettings
* to create(). For example:
*
*
To customize credentials:
*
*
{@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
* StorageTransferServiceSettings storageTransferServiceSettings =
* StorageTransferServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create(storageTransferServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* StorageTransferServiceSettings storageTransferServiceSettings =
* StorageTransferServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create(storageTransferServiceSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* StorageTransferServiceSettings storageTransferServiceSettings =
* StorageTransferServiceSettings.newHttpJsonBuilder().build();
* StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create(storageTransferServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class StorageTransferServiceClient implements BackgroundResource {
private final StorageTransferServiceSettings settings;
private final StorageTransferServiceStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of StorageTransferServiceClient with default settings. */
public static final StorageTransferServiceClient create() throws IOException {
return create(StorageTransferServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of StorageTransferServiceClient, using the given settings. The channels
* are created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final StorageTransferServiceClient create(StorageTransferServiceSettings settings)
throws IOException {
return new StorageTransferServiceClient(settings);
}
/**
* Constructs an instance of StorageTransferServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(StorageTransferServiceSettings).
*/
public static final StorageTransferServiceClient create(StorageTransferServiceStub stub) {
return new StorageTransferServiceClient(stub);
}
/**
* Constructs an instance of StorageTransferServiceClient, 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.
*/
protected StorageTransferServiceClient(StorageTransferServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub = ((StorageTransferServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected StorageTransferServiceClient(StorageTransferServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final StorageTransferServiceSettings getSettings() {
return settings;
}
public StorageTransferServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the Google service account that is used by Storage Transfer Service to access buckets
* in the project where transfers run or in other projects. Each Google service account is
* associated with one Google Cloud project. Users should add this service account to the Google
* Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is
* created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.
*
*
Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.GetGoogleServiceAccountRequest request =
* TransferProto.GetGoogleServiceAccountRequest.newBuilder()
* .setProjectId("projectId-894832108")
* .build();
* TransferTypes.GoogleServiceAccount response =
* storageTransferServiceClient.getGoogleServiceAccount(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.GoogleServiceAccount getGoogleServiceAccount(
TransferProto.GetGoogleServiceAccountRequest request) {
return getGoogleServiceAccountCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the Google service account that is used by Storage Transfer Service to access buckets
* in the project where transfers run or in other projects. Each Google service account is
* associated with one Google Cloud project. Users should add this service account to the Google
* Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is
* created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.GetGoogleServiceAccountRequest request =
* TransferProto.GetGoogleServiceAccountRequest.newBuilder()
* .setProjectId("projectId-894832108")
* .build();
* ApiFuture future =
* storageTransferServiceClient.getGoogleServiceAccountCallable().futureCall(request);
* // Do something.
* TransferTypes.GoogleServiceAccount response = future.get();
* }
* }
*/
public final UnaryCallable<
TransferProto.GetGoogleServiceAccountRequest, TransferTypes.GoogleServiceAccount>
getGoogleServiceAccountCallable() {
return stub.getGoogleServiceAccountCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a transfer job that runs periodically.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.CreateTransferJobRequest request =
* TransferProto.CreateTransferJobRequest.newBuilder()
* .setTransferJob(TransferTypes.TransferJob.newBuilder().build())
* .build();
* TransferTypes.TransferJob response = storageTransferServiceClient.createTransferJob(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.TransferJob createTransferJob(
TransferProto.CreateTransferJobRequest request) {
return createTransferJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a transfer job that runs periodically.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.CreateTransferJobRequest request =
* TransferProto.CreateTransferJobRequest.newBuilder()
* .setTransferJob(TransferTypes.TransferJob.newBuilder().build())
* .build();
* ApiFuture future =
* storageTransferServiceClient.createTransferJobCallable().futureCall(request);
* // Do something.
* TransferTypes.TransferJob response = future.get();
* }
* }
*/
public final UnaryCallable
createTransferJobCallable() {
return stub.createTransferJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that
* are running already.
*
* **Note:** The job's [status][google.storagetransfer.v1.TransferJob.status]
* field can be modified using this RPC (for example, to set a job's status to
* [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED],
* [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], or
* [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED]).
*
*
Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.UpdateTransferJobRequest request =
* TransferProto.UpdateTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .setTransferJob(TransferTypes.TransferJob.newBuilder().build())
* .setUpdateTransferJobFieldMask(FieldMask.newBuilder().build())
* .build();
* TransferTypes.TransferJob response = storageTransferServiceClient.updateTransferJob(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.TransferJob updateTransferJob(
TransferProto.UpdateTransferJobRequest request) {
return updateTransferJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that
* are running already.
*
* **Note:** The job's [status][google.storagetransfer.v1.TransferJob.status]
* field can be modified using this RPC (for example, to set a job's status to
* [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED],
* [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], or
* [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED]).
*
*
Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.UpdateTransferJobRequest request =
* TransferProto.UpdateTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .setTransferJob(TransferTypes.TransferJob.newBuilder().build())
* .setUpdateTransferJobFieldMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* storageTransferServiceClient.updateTransferJobCallable().futureCall(request);
* // Do something.
* TransferTypes.TransferJob response = future.get();
* }
* }
*/
public final UnaryCallable
updateTransferJobCallable() {
return stub.updateTransferJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a transfer job.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.GetTransferJobRequest request =
* TransferProto.GetTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .build();
* TransferTypes.TransferJob response = storageTransferServiceClient.getTransferJob(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.TransferJob getTransferJob(
TransferProto.GetTransferJobRequest request) {
return getTransferJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a transfer job.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.GetTransferJobRequest request =
* TransferProto.GetTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .build();
* ApiFuture future =
* storageTransferServiceClient.getTransferJobCallable().futureCall(request);
* // Do something.
* TransferTypes.TransferJob response = future.get();
* }
* }
*/
public final UnaryCallable
getTransferJobCallable() {
return stub.getTransferJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists transfer jobs.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.ListTransferJobsRequest request =
* TransferProto.ListTransferJobsRequest.newBuilder()
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (TransferTypes.TransferJob element :
* storageTransferServiceClient.listTransferJobs(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferJobsPagedResponse listTransferJobs(
TransferProto.ListTransferJobsRequest request) {
return listTransferJobsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists transfer jobs.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.ListTransferJobsRequest request =
* TransferProto.ListTransferJobsRequest.newBuilder()
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* storageTransferServiceClient.listTransferJobsPagedCallable().futureCall(request);
* // Do something.
* for (TransferTypes.TransferJob element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listTransferJobsPagedCallable() {
return stub.listTransferJobsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists transfer jobs.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.ListTransferJobsRequest request =
* TransferProto.ListTransferJobsRequest.newBuilder()
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* TransferProto.ListTransferJobsResponse response =
* storageTransferServiceClient.listTransferJobsCallable().call(request);
* for (TransferTypes.TransferJob element : response.getTransferJobsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable<
TransferProto.ListTransferJobsRequest, TransferProto.ListTransferJobsResponse>
listTransferJobsCallable() {
return stub.listTransferJobsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Pauses a transfer operation.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.PauseTransferOperationRequest request =
* TransferProto.PauseTransferOperationRequest.newBuilder().setName("name3373707").build();
* storageTransferServiceClient.pauseTransferOperation(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void pauseTransferOperation(TransferProto.PauseTransferOperationRequest request) {
pauseTransferOperationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Pauses a transfer operation.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.PauseTransferOperationRequest request =
* TransferProto.PauseTransferOperationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future =
* storageTransferServiceClient.pauseTransferOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
pauseTransferOperationCallable() {
return stub.pauseTransferOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resumes a transfer operation that is paused.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.ResumeTransferOperationRequest request =
* TransferProto.ResumeTransferOperationRequest.newBuilder().setName("name3373707").build();
* storageTransferServiceClient.resumeTransferOperation(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request) {
resumeTransferOperationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resumes a transfer operation that is paused.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.ResumeTransferOperationRequest request =
* TransferProto.ResumeTransferOperationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future =
* storageTransferServiceClient.resumeTransferOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
resumeTransferOperationCallable() {
return stub.resumeTransferOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts a new operation for the specified transfer job. A `TransferJob` has a maximum of one
* active `TransferOperation`. If this method is called while a `TransferOperation` is active, an
* error is returned.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.RunTransferJobRequest request =
* TransferProto.RunTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .build();
* storageTransferServiceClient.runTransferJobAsync(request).get();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture runTransferJobAsync(
TransferProto.RunTransferJobRequest request) {
return runTransferJobOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts a new operation for the specified transfer job. A `TransferJob` has a maximum of one
* active `TransferOperation`. If this method is called while a `TransferOperation` is active, an
* error is returned.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.RunTransferJobRequest request =
* TransferProto.RunTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .build();
* OperationFuture future =
* storageTransferServiceClient.runTransferJobOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable<
TransferProto.RunTransferJobRequest, Empty, TransferTypes.TransferOperation>
runTransferJobOperationCallable() {
return stub.runTransferJobOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Starts a new operation for the specified transfer job. A `TransferJob` has a maximum of one
* active `TransferOperation`. If this method is called while a `TransferOperation` is active, an
* error is returned.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.RunTransferJobRequest request =
* TransferProto.RunTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .build();
* ApiFuture future =
* storageTransferServiceClient.runTransferJobCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
runTransferJobCallable() {
return stub.runTransferJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a transfer job. Deleting a transfer job sets its status to
* [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.DeleteTransferJobRequest request =
* TransferProto.DeleteTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .build();
* storageTransferServiceClient.deleteTransferJob(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransferJob(TransferProto.DeleteTransferJobRequest request) {
deleteTransferJobCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a transfer job. Deleting a transfer job sets its status to
* [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.DeleteTransferJobRequest request =
* TransferProto.DeleteTransferJobRequest.newBuilder()
* .setJobName("jobName-1438096408")
* .setProjectId("projectId-894832108")
* .build();
* ApiFuture future =
* storageTransferServiceClient.deleteTransferJobCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
deleteTransferJobCallable() {
return stub.deleteTransferJobCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an agent pool resource.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* String projectId = "projectId-894832108";
* TransferTypes.AgentPool agentPool = TransferTypes.AgentPool.newBuilder().build();
* String agentPoolId = "agentPoolId1562124732";
* TransferTypes.AgentPool response =
* storageTransferServiceClient.createAgentPool(projectId, agentPool, agentPoolId);
* }
* }
*
* @param projectId Required. The ID of the Google Cloud project that owns the agent pool.
* @param agentPool Required. The agent pool to create.
* @param agentPoolId Required. The ID of the agent pool to create.
* The `agent_pool_id` must meet the following requirements:
*
* - Length of 128 characters or less.
*
- Not start with the string `goog`.
*
- Start with a lowercase ASCII character, followed by: * Zero or more: lowercase
* Latin alphabet characters, numerals, hyphens (`-`), periods (`.`), underscores (`_`),
* or tildes (`~`). * One or more numerals or lowercase ASCII characters.
*
* As expressed by the regular expression: `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.AgentPool createAgentPool(
String projectId, TransferTypes.AgentPool agentPool, String agentPoolId) {
TransferProto.CreateAgentPoolRequest request =
TransferProto.CreateAgentPoolRequest.newBuilder()
.setProjectId(projectId)
.setAgentPool(agentPool)
.setAgentPoolId(agentPoolId)
.build();
return createAgentPool(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an agent pool resource.
*
*
Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.CreateAgentPoolRequest request =
* TransferProto.CreateAgentPoolRequest.newBuilder()
* .setProjectId("projectId-894832108")
* .setAgentPool(TransferTypes.AgentPool.newBuilder().build())
* .setAgentPoolId("agentPoolId1562124732")
* .build();
* TransferTypes.AgentPool response = storageTransferServiceClient.createAgentPool(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.AgentPool createAgentPool(
TransferProto.CreateAgentPoolRequest request) {
return createAgentPoolCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an agent pool resource.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.CreateAgentPoolRequest request =
* TransferProto.CreateAgentPoolRequest.newBuilder()
* .setProjectId("projectId-894832108")
* .setAgentPool(TransferTypes.AgentPool.newBuilder().build())
* .setAgentPoolId("agentPoolId1562124732")
* .build();
* ApiFuture future =
* storageTransferServiceClient.createAgentPoolCallable().futureCall(request);
* // Do something.
* TransferTypes.AgentPool response = future.get();
* }
* }
*/
public final UnaryCallable
createAgentPoolCallable() {
return stub.createAgentPoolCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing agent pool resource.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferTypes.AgentPool agentPool = TransferTypes.AgentPool.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* TransferTypes.AgentPool response =
* storageTransferServiceClient.updateAgentPool(agentPool, updateMask);
* }
* }
*
* @param agentPool Required. The agent pool to update. `agent_pool` is expected to specify
* following fields:
*
* - [name][google.storagetransfer.v1.AgentPool.name]
*
*
* - [display_name][google.storagetransfer.v1.AgentPool.display_name]
*
*
* - [bandwidth_limit][google.storagetransfer.v1.AgentPool.bandwidth_limit] An
* `UpdateAgentPoolRequest` with any other fields is rejected with the error
* [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].
*
*
* @param updateMask The [field mask]
* (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the
* fields in `agentPool` to update in this request. The following `agentPool` fields can be
* updated:
*
* - [display_name][google.storagetransfer.v1.AgentPool.display_name]
*
*
* - [bandwidth_limit][google.storagetransfer.v1.AgentPool.bandwidth_limit]
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.AgentPool updateAgentPool(
TransferTypes.AgentPool agentPool, FieldMask updateMask) {
TransferProto.UpdateAgentPoolRequest request =
TransferProto.UpdateAgentPoolRequest.newBuilder()
.setAgentPool(agentPool)
.setUpdateMask(updateMask)
.build();
return updateAgentPool(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing agent pool resource.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.UpdateAgentPoolRequest request =
* TransferProto.UpdateAgentPoolRequest.newBuilder()
* .setAgentPool(TransferTypes.AgentPool.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* TransferTypes.AgentPool response = storageTransferServiceClient.updateAgentPool(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.AgentPool updateAgentPool(
TransferProto.UpdateAgentPoolRequest request) {
return updateAgentPoolCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing agent pool resource.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.UpdateAgentPoolRequest request =
* TransferProto.UpdateAgentPoolRequest.newBuilder()
* .setAgentPool(TransferTypes.AgentPool.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* storageTransferServiceClient.updateAgentPoolCallable().futureCall(request);
* // Do something.
* TransferTypes.AgentPool response = future.get();
* }
* }
*/
public final UnaryCallable
updateAgentPoolCallable() {
return stub.updateAgentPoolCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an agent pool.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* String name = "name3373707";
* TransferTypes.AgentPool response = storageTransferServiceClient.getAgentPool(name);
* }
* }
*
* @param name Required. The name of the agent pool to get.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.AgentPool getAgentPool(String name) {
TransferProto.GetAgentPoolRequest request =
TransferProto.GetAgentPoolRequest.newBuilder().setName(name).build();
return getAgentPool(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an agent pool.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.GetAgentPoolRequest request =
* TransferProto.GetAgentPoolRequest.newBuilder().setName("name3373707").build();
* TransferTypes.AgentPool response = storageTransferServiceClient.getAgentPool(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferTypes.AgentPool getAgentPool(TransferProto.GetAgentPoolRequest request) {
return getAgentPoolCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an agent pool.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.GetAgentPoolRequest request =
* TransferProto.GetAgentPoolRequest.newBuilder().setName("name3373707").build();
* ApiFuture future =
* storageTransferServiceClient.getAgentPoolCallable().futureCall(request);
* // Do something.
* TransferTypes.AgentPool response = future.get();
* }
* }
*/
public final UnaryCallable
getAgentPoolCallable() {
return stub.getAgentPoolCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists agent pools.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* String projectId = "projectId-894832108";
* for (TransferTypes.AgentPool element :
* storageTransferServiceClient.listAgentPools(projectId).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param projectId Required. The ID of the Google Cloud project that owns the job.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAgentPoolsPagedResponse listAgentPools(String projectId) {
TransferProto.ListAgentPoolsRequest request =
TransferProto.ListAgentPoolsRequest.newBuilder().setProjectId(projectId).build();
return listAgentPools(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists agent pools.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.ListAgentPoolsRequest request =
* TransferProto.ListAgentPoolsRequest.newBuilder()
* .setProjectId("projectId-894832108")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (TransferTypes.AgentPool element :
* storageTransferServiceClient.listAgentPools(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAgentPoolsPagedResponse listAgentPools(
TransferProto.ListAgentPoolsRequest request) {
return listAgentPoolsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists agent pools.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.ListAgentPoolsRequest request =
* TransferProto.ListAgentPoolsRequest.newBuilder()
* .setProjectId("projectId-894832108")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* storageTransferServiceClient.listAgentPoolsPagedCallable().futureCall(request);
* // Do something.
* for (TransferTypes.AgentPool element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listAgentPoolsPagedCallable() {
return stub.listAgentPoolsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists agent pools.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.ListAgentPoolsRequest request =
* TransferProto.ListAgentPoolsRequest.newBuilder()
* .setProjectId("projectId-894832108")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* TransferProto.ListAgentPoolsResponse response =
* storageTransferServiceClient.listAgentPoolsCallable().call(request);
* for (TransferTypes.AgentPool element : response.getAgentPoolsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable<
TransferProto.ListAgentPoolsRequest, TransferProto.ListAgentPoolsResponse>
listAgentPoolsCallable() {
return stub.listAgentPoolsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an agent pool.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* String name = "name3373707";
* storageTransferServiceClient.deleteAgentPool(name);
* }
* }
*
* @param name Required. The name of the agent pool to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAgentPool(String name) {
TransferProto.DeleteAgentPoolRequest request =
TransferProto.DeleteAgentPoolRequest.newBuilder().setName(name).build();
deleteAgentPool(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an agent pool.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.DeleteAgentPoolRequest request =
* TransferProto.DeleteAgentPoolRequest.newBuilder().setName("name3373707").build();
* storageTransferServiceClient.deleteAgentPool(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteAgentPool(TransferProto.DeleteAgentPoolRequest request) {
deleteAgentPoolCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an agent pool.
*
* Sample code:
*
*
{@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 (StorageTransferServiceClient storageTransferServiceClient =
* StorageTransferServiceClient.create()) {
* TransferProto.DeleteAgentPoolRequest request =
* TransferProto.DeleteAgentPoolRequest.newBuilder().setName("name3373707").build();
* ApiFuture future =
* storageTransferServiceClient.deleteAgentPoolCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
deleteAgentPoolCallable() {
return stub.deleteAgentPoolCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListTransferJobsPagedResponse
extends AbstractPagedListResponse<
TransferProto.ListTransferJobsRequest,
TransferProto.ListTransferJobsResponse,
TransferTypes.TransferJob,
ListTransferJobsPage,
ListTransferJobsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext<
TransferProto.ListTransferJobsRequest,
TransferProto.ListTransferJobsResponse,
TransferTypes.TransferJob>
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListTransferJobsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListTransferJobsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListTransferJobsPagedResponse(ListTransferJobsPage page) {
super(page, ListTransferJobsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListTransferJobsPage
extends AbstractPage<
TransferProto.ListTransferJobsRequest,
TransferProto.ListTransferJobsResponse,
TransferTypes.TransferJob,
ListTransferJobsPage> {
private ListTransferJobsPage(
PageContext<
TransferProto.ListTransferJobsRequest,
TransferProto.ListTransferJobsResponse,
TransferTypes.TransferJob>
context,
TransferProto.ListTransferJobsResponse response) {
super(context, response);
}
private static ListTransferJobsPage createEmptyPage() {
return new ListTransferJobsPage(null, null);
}
@Override
protected ListTransferJobsPage createPage(
PageContext<
TransferProto.ListTransferJobsRequest,
TransferProto.ListTransferJobsResponse,
TransferTypes.TransferJob>
context,
TransferProto.ListTransferJobsResponse response) {
return new ListTransferJobsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext<
TransferProto.ListTransferJobsRequest,
TransferProto.ListTransferJobsResponse,
TransferTypes.TransferJob>
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListTransferJobsFixedSizeCollection
extends AbstractFixedSizeCollection<
TransferProto.ListTransferJobsRequest,
TransferProto.ListTransferJobsResponse,
TransferTypes.TransferJob,
ListTransferJobsPage,
ListTransferJobsFixedSizeCollection> {
private ListTransferJobsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListTransferJobsFixedSizeCollection createEmptyCollection() {
return new ListTransferJobsFixedSizeCollection(null, 0);
}
@Override
protected ListTransferJobsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListTransferJobsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListAgentPoolsPagedResponse
extends AbstractPagedListResponse<
TransferProto.ListAgentPoolsRequest,
TransferProto.ListAgentPoolsResponse,
TransferTypes.AgentPool,
ListAgentPoolsPage,
ListAgentPoolsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext<
TransferProto.ListAgentPoolsRequest,
TransferProto.ListAgentPoolsResponse,
TransferTypes.AgentPool>
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListAgentPoolsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListAgentPoolsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListAgentPoolsPagedResponse(ListAgentPoolsPage page) {
super(page, ListAgentPoolsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListAgentPoolsPage
extends AbstractPage<
TransferProto.ListAgentPoolsRequest,
TransferProto.ListAgentPoolsResponse,
TransferTypes.AgentPool,
ListAgentPoolsPage> {
private ListAgentPoolsPage(
PageContext<
TransferProto.ListAgentPoolsRequest,
TransferProto.ListAgentPoolsResponse,
TransferTypes.AgentPool>
context,
TransferProto.ListAgentPoolsResponse response) {
super(context, response);
}
private static ListAgentPoolsPage createEmptyPage() {
return new ListAgentPoolsPage(null, null);
}
@Override
protected ListAgentPoolsPage createPage(
PageContext<
TransferProto.ListAgentPoolsRequest,
TransferProto.ListAgentPoolsResponse,
TransferTypes.AgentPool>
context,
TransferProto.ListAgentPoolsResponse response) {
return new ListAgentPoolsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext<
TransferProto.ListAgentPoolsRequest,
TransferProto.ListAgentPoolsResponse,
TransferTypes.AgentPool>
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListAgentPoolsFixedSizeCollection
extends AbstractFixedSizeCollection<
TransferProto.ListAgentPoolsRequest,
TransferProto.ListAgentPoolsResponse,
TransferTypes.AgentPool,
ListAgentPoolsPage,
ListAgentPoolsFixedSizeCollection> {
private ListAgentPoolsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListAgentPoolsFixedSizeCollection createEmptyCollection() {
return new ListAgentPoolsFixedSizeCollection(null, 0);
}
@Override
protected ListAgentPoolsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListAgentPoolsFixedSizeCollection(pages, collectionSize);
}
}
}