@Generated("by gapic-generator-java")
Package com.google.storagetransfer.v1.proto
A client to Storage Transfer API
The interfaces provided are listed below, along with usage samples.
======================= StorageTransferServiceClient =======================
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.
Sample for StorageTransferServiceClient:
// 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);
}
-
Class Summary Class Description StorageTransferServiceClient Service Description: Storage Transfer Service and its protos.StorageTransferServiceClient.ListAgentPoolsFixedSizeCollection StorageTransferServiceClient.ListAgentPoolsPage StorageTransferServiceClient.ListAgentPoolsPagedResponse StorageTransferServiceClient.ListTransferJobsFixedSizeCollection StorageTransferServiceClient.ListTransferJobsPage StorageTransferServiceClient.ListTransferJobsPagedResponse StorageTransferServiceGrpc Storage Transfer Service and its protos.StorageTransferServiceGrpc.StorageTransferServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service StorageTransferService.StorageTransferServiceGrpc.StorageTransferServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service StorageTransferService.StorageTransferServiceGrpc.StorageTransferServiceImplBase Base class for the server implementation of the service StorageTransferService.StorageTransferServiceGrpc.StorageTransferServiceStub A stub to allow clients to do asynchronous rpc calls to service StorageTransferService.StorageTransferServiceSettings Settings class to configure an instance ofStorageTransferServiceClient
.StorageTransferServiceSettings.Builder Builder for StorageTransferServiceSettings.TransferProto TransferProto.CreateAgentPoolRequest Specifies the request passed to CreateAgentPool.TransferProto.CreateAgentPoolRequest.Builder Specifies the request passed to CreateAgentPool.TransferProto.CreateTransferJobRequest Request passed to CreateTransferJob.TransferProto.CreateTransferJobRequest.Builder Request passed to CreateTransferJob.TransferProto.DeleteAgentPoolRequest Specifies the request passed to DeleteAgentPool.TransferProto.DeleteAgentPoolRequest.Builder Specifies the request passed to DeleteAgentPool.TransferProto.DeleteTransferJobRequest Request passed to DeleteTransferJob.TransferProto.DeleteTransferJobRequest.Builder Request passed to DeleteTransferJob.TransferProto.GetAgentPoolRequest Specifies the request passed to GetAgentPool.TransferProto.GetAgentPoolRequest.Builder Specifies the request passed to GetAgentPool.TransferProto.GetGoogleServiceAccountRequest Request passed to GetGoogleServiceAccount.TransferProto.GetGoogleServiceAccountRequest.Builder Request passed to GetGoogleServiceAccount.TransferProto.GetTransferJobRequest Request passed to GetTransferJob.TransferProto.GetTransferJobRequest.Builder Request passed to GetTransferJob.TransferProto.ListAgentPoolsRequest The request passed to ListAgentPools.TransferProto.ListAgentPoolsRequest.Builder The request passed to ListAgentPools.TransferProto.ListAgentPoolsResponse Response from ListAgentPools.TransferProto.ListAgentPoolsResponse.Builder Response from ListAgentPools.TransferProto.ListTransferJobsRequest `projectId`, `jobNames`, and `jobStatuses` are query parameters that can be specified when listing transfer jobs.TransferProto.ListTransferJobsRequest.Builder `projectId`, `jobNames`, and `jobStatuses` are query parameters that can be specified when listing transfer jobs.TransferProto.ListTransferJobsResponse Response from ListTransferJobs.TransferProto.ListTransferJobsResponse.Builder Response from ListTransferJobs.TransferProto.PauseTransferOperationRequest Request passed to PauseTransferOperation.TransferProto.PauseTransferOperationRequest.Builder Request passed to PauseTransferOperation.TransferProto.ResumeTransferOperationRequest Request passed to ResumeTransferOperation.TransferProto.ResumeTransferOperationRequest.Builder Request passed to ResumeTransferOperation.TransferProto.RunTransferJobRequest Request passed to RunTransferJob.TransferProto.RunTransferJobRequest.Builder Request passed to RunTransferJob.TransferProto.UpdateAgentPoolRequest Specifies the request passed to UpdateAgentPool.TransferProto.UpdateAgentPoolRequest.Builder Specifies the request passed to UpdateAgentPool.TransferProto.UpdateTransferJobRequest Request passed to UpdateTransferJob.TransferProto.UpdateTransferJobRequest.Builder Request passed to UpdateTransferJob.TransferTypes TransferTypes.AgentPool Represents an On-Premises Agent pool.TransferTypes.AgentPool.BandwidthLimit Specifies a bandwidth limit for an agent pool.TransferTypes.AgentPool.BandwidthLimit.Builder Specifies a bandwidth limit for an agent pool.TransferTypes.AgentPool.Builder Represents an On-Premises Agent pool.TransferTypes.AwsAccessKey AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).TransferTypes.AwsAccessKey.Builder AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).TransferTypes.AwsS3CompatibleData An AwsS3CompatibleData resource.TransferTypes.AwsS3CompatibleData.Builder An AwsS3CompatibleData resource.TransferTypes.AwsS3Data An AwsS3Data resource can be a data source, but not a data sink.TransferTypes.AwsS3Data.Builder An AwsS3Data resource can be a data source, but not a data sink.TransferTypes.AzureBlobStorageData An AzureBlobStorageData resource can be a data source, but not a data sink.TransferTypes.AzureBlobStorageData.Builder An AzureBlobStorageData resource can be a data source, but not a data sink.TransferTypes.AzureCredentials Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials).TransferTypes.AzureCredentials.Builder Azure credentials For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials).TransferTypes.ErrorLogEntry An entry describing an error that has occurred.TransferTypes.ErrorLogEntry.Builder An entry describing an error that has occurred.TransferTypes.ErrorSummary A summary of errors by error code, plus a count and sample error log entries.TransferTypes.ErrorSummary.Builder A summary of errors by error code, plus a count and sample error log entries.TransferTypes.EventStream Specifies the Event-driven transfer options.TransferTypes.EventStream.Builder Specifies the Event-driven transfer options.TransferTypes.GcsData In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated.TransferTypes.GcsData.Builder In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated.TransferTypes.GoogleServiceAccount Google service accountTransferTypes.GoogleServiceAccount.Builder Google service accountTransferTypes.HttpData An HttpData resource specifies a list of objects on the web to be transferred over HTTP.TransferTypes.HttpData.Builder An HttpData resource specifies a list of objects on the web to be transferred over HTTP.TransferTypes.LoggingConfig Specifies the logging behavior for transfer operations.TransferTypes.LoggingConfig.Builder Specifies the logging behavior for transfer operations.TransferTypes.MetadataOptions Specifies the metadata options for running a transfer.TransferTypes.MetadataOptions.Builder Specifies the metadata options for running a transfer.TransferTypes.NotificationConfig Specification to configure notifications published to Pub/Sub.TransferTypes.NotificationConfig.Builder Specification to configure notifications published to Pub/Sub.TransferTypes.ObjectConditions Conditions that determine which objects are transferred.TransferTypes.ObjectConditions.Builder Conditions that determine which objects are transferred.TransferTypes.PosixFilesystem A POSIX filesystem resource.TransferTypes.PosixFilesystem.Builder A POSIX filesystem resource.TransferTypes.S3CompatibleMetadata S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.TransferTypes.S3CompatibleMetadata.Builder S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.TransferTypes.Schedule Transfers can be scheduled to recur or to run just once.TransferTypes.Schedule.Builder Transfers can be scheduled to recur or to run just once.TransferTypes.TransferCounters A collection of counters that report the progress of a transfer operation.TransferTypes.TransferCounters.Builder A collection of counters that report the progress of a transfer operation.TransferTypes.TransferJob This resource represents the configuration of a transfer job that runs periodically.TransferTypes.TransferJob.Builder This resource represents the configuration of a transfer job that runs periodically.TransferTypes.TransferManifest Specifies where the manifest is located.TransferTypes.TransferManifest.Builder Specifies where the manifest is located.TransferTypes.TransferOperation A description of the execution of a transfer.TransferTypes.TransferOperation.Builder A description of the execution of a transfer.TransferTypes.TransferOptions TransferOptions define the actions to be performed on objects in a transfer.TransferTypes.TransferOptions.Builder TransferOptions define the actions to be performed on objects in a transfer.TransferTypes.TransferSpec Configuration for running a transfer.TransferTypes.TransferSpec.Builder Configuration for running a transfer. -
Enum Summary Enum Description TransferTypes.AgentPool.State The state of an AgentPool.TransferTypes.AwsS3CompatibleData.DataProviderCase TransferTypes.LoggingConfig.LoggableAction Loggable actions.TransferTypes.LoggingConfig.LoggableActionState Loggable action states.TransferTypes.MetadataOptions.Acl Options for handling Cloud Storage object ACLs.TransferTypes.MetadataOptions.GID Options for handling file GID attribute.TransferTypes.MetadataOptions.KmsKey Options for handling the KmsKey setting for Google Cloud Storage objects.TransferTypes.MetadataOptions.Mode Options for handling file mode attribute.TransferTypes.MetadataOptions.StorageClass Options for handling Google Cloud Storage object storage class.TransferTypes.MetadataOptions.Symlink Whether symlinks should be skipped or preserved during a transfer job.TransferTypes.MetadataOptions.TemporaryHold Options for handling temporary holds for Google Cloud Storage objects.TransferTypes.MetadataOptions.TimeCreated Options for handling `timeCreated` metadata for Google Cloud Storage objects.TransferTypes.MetadataOptions.UID Options for handling file UID attribute.TransferTypes.NotificationConfig.EventType Enum for specifying event types for which notifications are to be published.TransferTypes.NotificationConfig.PayloadFormat Enum for specifying the format of a notification message's payload.TransferTypes.S3CompatibleMetadata.AuthMethod The authentication and authorization method used by the storage service.TransferTypes.S3CompatibleMetadata.ListApi The Listing API to use for discovering objects.TransferTypes.S3CompatibleMetadata.NetworkProtocol The agent network protocol to access the storage service.TransferTypes.S3CompatibleMetadata.RequestModel The request model of the API.TransferTypes.TransferJob.Status The status of the transfer job.TransferTypes.TransferOperation.Status The status of a TransferOperation.TransferTypes.TransferOptions.OverwriteWhen Specifies when to overwrite an object in the sink when an object with matching name is found in the source.TransferTypes.TransferSpec.DataSinkCase TransferTypes.TransferSpec.DataSourceCase TransferTypes.TransferSpec.IntermediateDataLocationCase