Package com.google.storagetransfer.v1.proto (1.45.0)

GitHub Repository

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.storagetransfer.v1.proto.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.

This class provides the ability to make remote calls to the backing service through method

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.storagetransfer.v1.proto.StorageTransferServiceSettings Settings class to configure an instance of StorageTransferServiceClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.storagetransfer.v1.proto.StorageTransferServiceClient.ListAgentPoolsFixedSizeCollection
com.google.storagetransfer.v1.proto.StorageTransferServiceClient.ListAgentPoolsPage
com.google.storagetransfer.v1.proto.StorageTransferServiceClient.ListAgentPoolsPagedResponse
com.google.storagetransfer.v1.proto.StorageTransferServiceClient.ListTransferJobsFixedSizeCollection
com.google.storagetransfer.v1.proto.StorageTransferServiceClient.ListTransferJobsPage
com.google.storagetransfer.v1.proto.StorageTransferServiceClient.ListTransferJobsPagedResponse
com.google.storagetransfer.v1.proto.StorageTransferServiceGrpc 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.
com.google.storagetransfer.v1.proto.StorageTransferServiceGrpc.StorageTransferServiceImplBase Base class for the server implementation of the service StorageTransferService. Storage Transfer Service and its protos.
com.google.storagetransfer.v1.proto.StorageTransferServiceSettings.Builder Builder for StorageTransferServiceSettings.
com.google.storagetransfer.v1.proto.TransferProto
com.google.storagetransfer.v1.proto.TransferProto.CreateAgentPoolRequest Specifies the request passed to CreateAgentPool.
com.google.storagetransfer.v1.proto.TransferProto.CreateAgentPoolRequest.Builder Specifies the request passed to CreateAgentPool.
com.google.storagetransfer.v1.proto.TransferProto.CreateTransferJobRequest Request passed to CreateTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.CreateTransferJobRequest.Builder Request passed to CreateTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.DeleteAgentPoolRequest Specifies the request passed to DeleteAgentPool.
com.google.storagetransfer.v1.proto.TransferProto.DeleteAgentPoolRequest.Builder Specifies the request passed to DeleteAgentPool.
com.google.storagetransfer.v1.proto.TransferProto.DeleteTransferJobRequest Request passed to DeleteTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.DeleteTransferJobRequest.Builder Request passed to DeleteTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.GetAgentPoolRequest Specifies the request passed to GetAgentPool.
com.google.storagetransfer.v1.proto.TransferProto.GetAgentPoolRequest.Builder Specifies the request passed to GetAgentPool.
com.google.storagetransfer.v1.proto.TransferProto.GetGoogleServiceAccountRequest Request passed to GetGoogleServiceAccount.
com.google.storagetransfer.v1.proto.TransferProto.GetGoogleServiceAccountRequest.Builder Request passed to GetGoogleServiceAccount.
com.google.storagetransfer.v1.proto.TransferProto.GetTransferJobRequest Request passed to GetTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.GetTransferJobRequest.Builder Request passed to GetTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.ListAgentPoolsRequest The request passed to ListAgentPools.
com.google.storagetransfer.v1.proto.TransferProto.ListAgentPoolsRequest.Builder The request passed to ListAgentPools.
com.google.storagetransfer.v1.proto.TransferProto.ListAgentPoolsResponse Response from ListAgentPools.
com.google.storagetransfer.v1.proto.TransferProto.ListAgentPoolsResponse.Builder Response from ListAgentPools.
com.google.storagetransfer.v1.proto.TransferProto.ListTransferJobsRequest projectId, jobNames, and jobStatuses are query parameters that can be specified when listing transfer jobs.
com.google.storagetransfer.v1.proto.TransferProto.ListTransferJobsRequest.Builder projectId, jobNames, and jobStatuses are query parameters that can be specified when listing transfer jobs.
com.google.storagetransfer.v1.proto.TransferProto.ListTransferJobsResponse Response from ListTransferJobs.
com.google.storagetransfer.v1.proto.TransferProto.ListTransferJobsResponse.Builder Response from ListTransferJobs.
com.google.storagetransfer.v1.proto.TransferProto.PauseTransferOperationRequest Request passed to PauseTransferOperation.
com.google.storagetransfer.v1.proto.TransferProto.PauseTransferOperationRequest.Builder Request passed to PauseTransferOperation.
com.google.storagetransfer.v1.proto.TransferProto.ResumeTransferOperationRequest Request passed to ResumeTransferOperation.
com.google.storagetransfer.v1.proto.TransferProto.ResumeTransferOperationRequest.Builder Request passed to ResumeTransferOperation.
com.google.storagetransfer.v1.proto.TransferProto.RunTransferJobRequest Request passed to RunTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.RunTransferJobRequest.Builder Request passed to RunTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.UpdateAgentPoolRequest Specifies the request passed to UpdateAgentPool.
com.google.storagetransfer.v1.proto.TransferProto.UpdateAgentPoolRequest.Builder Specifies the request passed to UpdateAgentPool.
com.google.storagetransfer.v1.proto.TransferProto.UpdateTransferJobRequest Request passed to UpdateTransferJob.
com.google.storagetransfer.v1.proto.TransferProto.UpdateTransferJobRequest.Builder Request passed to UpdateTransferJob.
com.google.storagetransfer.v1.proto.TransferTypes
com.google.storagetransfer.v1.proto.TransferTypes.AgentPool Represents an On-Premises Agent pool.
com.google.storagetransfer.v1.proto.TransferTypes.AgentPool.BandwidthLimit Specifies a bandwidth limit for an agent pool.
com.google.storagetransfer.v1.proto.TransferTypes.AgentPool.BandwidthLimit.Builder Specifies a bandwidth limit for an agent pool.
com.google.storagetransfer.v1.proto.TransferTypes.AgentPool.Builder Represents an On-Premises Agent pool.
com.google.storagetransfer.v1.proto.TransferTypes.AwsAccessKey AWS access key (see AWS Security Credentials).
com.google.storagetransfer.v1.proto.TransferTypes.AwsAccessKey.Builder AWS access key (see AWS Security Credentials).
com.google.storagetransfer.v1.proto.TransferTypes.AwsS3CompatibleData An AwsS3CompatibleData resource.
com.google.storagetransfer.v1.proto.TransferTypes.AwsS3CompatibleData.Builder An AwsS3CompatibleData resource.
com.google.storagetransfer.v1.proto.TransferTypes.AwsS3Data An AwsS3Data resource can be a data source, but not a data sink. In an AwsS3Data resource, an object's name is the S3 object's key name.
com.google.storagetransfer.v1.proto.TransferTypes.AwsS3Data.Builder An AwsS3Data resource can be a data source, but not a data sink. In an AwsS3Data resource, an object's name is the S3 object's key name.
com.google.storagetransfer.v1.proto.TransferTypes.AzureBlobStorageData An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the Azure
com.google.storagetransfer.v1.proto.TransferTypes.AzureBlobStorageData.Builder An AzureBlobStorageData resource can be a data source, but not a data sink. An AzureBlobStorageData resource represents one Azure container. The storage account determines the Azure
com.google.storagetransfer.v1.proto.TransferTypes.AzureCredentials Azure credentials For information on our data retention policy for user credentials, see
com.google.storagetransfer.v1.proto.TransferTypes.AzureCredentials.Builder Azure credentials For information on our data retention policy for user credentials, see
com.google.storagetransfer.v1.proto.TransferTypes.ErrorLogEntry An entry describing an error that has occurred.
com.google.storagetransfer.v1.proto.TransferTypes.ErrorLogEntry.Builder An entry describing an error that has occurred.
com.google.storagetransfer.v1.proto.TransferTypes.ErrorSummary A summary of errors by error code, plus a count and sample error log entries.
com.google.storagetransfer.v1.proto.TransferTypes.ErrorSummary.Builder A summary of errors by error code, plus a count and sample error log entries.
com.google.storagetransfer.v1.proto.TransferTypes.EventStream Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
com.google.storagetransfer.v1.proto.TransferTypes.EventStream.Builder Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
com.google.storagetransfer.v1.proto.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
com.google.storagetransfer.v1.proto.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
com.google.storagetransfer.v1.proto.TransferTypes.GoogleServiceAccount Google service account
com.google.storagetransfer.v1.proto.TransferTypes.GoogleServiceAccount.Builder Google service account
com.google.storagetransfer.v1.proto.TransferTypes.HttpData An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be
com.google.storagetransfer.v1.proto.TransferTypes.HttpData.Builder An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be
com.google.storagetransfer.v1.proto.TransferTypes.LoggingConfig Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See
com.google.storagetransfer.v1.proto.TransferTypes.LoggingConfig.Builder Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions Specifies the metadata options for running a transfer.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.Builder Specifies the metadata options for running a transfer.
com.google.storagetransfer.v1.proto.TransferTypes.NotificationConfig Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following PubsubMessage.attributes:
com.google.storagetransfer.v1.proto.TransferTypes.NotificationConfig.Builder Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following PubsubMessage.attributes:
com.google.storagetransfer.v1.proto.TransferTypes.ObjectConditions Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage.
com.google.storagetransfer.v1.proto.TransferTypes.ObjectConditions.Builder Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage.
com.google.storagetransfer.v1.proto.TransferTypes.PosixFilesystem A POSIX filesystem resource.
com.google.storagetransfer.v1.proto.TransferTypes.PosixFilesystem.Builder A POSIX filesystem resource.
com.google.storagetransfer.v1.proto.TransferTypes.S3CompatibleMetadata S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.
com.google.storagetransfer.v1.proto.TransferTypes.S3CompatibleMetadata.Builder S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.
com.google.storagetransfer.v1.proto.TransferTypes.Schedule Transfers can be scheduled to recur or to run just once.
com.google.storagetransfer.v1.proto.TransferTypes.Schedule.Builder Transfers can be scheduled to recur or to run just once.
com.google.storagetransfer.v1.proto.TransferTypes.TransferCounters A collection of counters that report the progress of a transfer operation.
com.google.storagetransfer.v1.proto.TransferTypes.TransferCounters.Builder A collection of counters that report the progress of a transfer operation.
com.google.storagetransfer.v1.proto.TransferTypes.TransferJob This resource represents the configuration of a transfer job that runs periodically.
com.google.storagetransfer.v1.proto.TransferTypes.TransferJob.Builder This resource represents the configuration of a transfer job that runs periodically.
com.google.storagetransfer.v1.proto.TransferTypes.TransferManifest Specifies where the manifest is located.
com.google.storagetransfer.v1.proto.TransferTypes.TransferManifest.Builder Specifies where the manifest is located.
com.google.storagetransfer.v1.proto.TransferTypes.TransferOperation A description of the execution of a transfer.
com.google.storagetransfer.v1.proto.TransferTypes.TransferOperation.Builder A description of the execution of a transfer.
com.google.storagetransfer.v1.proto.TransferTypes.TransferOptions TransferOptions define the actions to be performed on objects in a transfer.
com.google.storagetransfer.v1.proto.TransferTypes.TransferOptions.Builder TransferOptions define the actions to be performed on objects in a transfer.
com.google.storagetransfer.v1.proto.TransferTypes.TransferSpec Configuration for running a transfer.
com.google.storagetransfer.v1.proto.TransferTypes.TransferSpec.Builder Configuration for running a transfer.

Interfaces

Interface Description
com.google.storagetransfer.v1.proto.StorageTransferServiceGrpc.AsyncService 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.
com.google.storagetransfer.v1.proto.TransferProto.CreateAgentPoolRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.CreateTransferJobRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.DeleteAgentPoolRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.DeleteTransferJobRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.GetAgentPoolRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.GetGoogleServiceAccountRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.GetTransferJobRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.ListAgentPoolsRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.ListAgentPoolsResponseOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.ListTransferJobsRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.ListTransferJobsResponseOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.PauseTransferOperationRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.ResumeTransferOperationRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.RunTransferJobRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.UpdateAgentPoolRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferProto.UpdateTransferJobRequestOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.AgentPool.BandwidthLimitOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.AgentPoolOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.AwsAccessKeyOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.AwsS3CompatibleDataOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.AwsS3DataOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.AzureBlobStorageDataOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.AzureCredentialsOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.ErrorLogEntryOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.ErrorSummaryOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.EventStreamOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.GcsDataOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.GoogleServiceAccountOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.HttpDataOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.LoggingConfigOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptionsOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.NotificationConfigOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.ObjectConditionsOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.PosixFilesystemOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.S3CompatibleMetadataOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.ScheduleOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.TransferCountersOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.TransferJobOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.TransferManifestOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.TransferOperationOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.TransferOptionsOrBuilder
com.google.storagetransfer.v1.proto.TransferTypes.TransferSpecOrBuilder

Enums

Enum Description
com.google.storagetransfer.v1.proto.TransferTypes.AgentPool.State The state of an AgentPool.
com.google.storagetransfer.v1.proto.TransferTypes.AwsS3CompatibleData.DataProviderCase
com.google.storagetransfer.v1.proto.TransferTypes.LoggingConfig.LoggableAction Loggable actions.
com.google.storagetransfer.v1.proto.TransferTypes.LoggingConfig.LoggableActionState Loggable action states.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.Acl Options for handling Cloud Storage object ACLs.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.GID Options for handling file GID attribute.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.KmsKey Options for handling the KmsKey setting for Google Cloud Storage objects.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.Mode Options for handling file mode attribute.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.StorageClass Options for handling Google Cloud Storage object storage class.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.Symlink Whether symlinks should be skipped or preserved during a transfer job.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.TemporaryHold Options for handling temporary holds for Google Cloud Storage objects.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.TimeCreated Options for handling timeCreated metadata for Google Cloud Storage objects.
com.google.storagetransfer.v1.proto.TransferTypes.MetadataOptions.UID Options for handling file UID attribute.
com.google.storagetransfer.v1.proto.TransferTypes.NotificationConfig.EventType Enum for specifying event types for which notifications are to be published.
com.google.storagetransfer.v1.proto.TransferTypes.NotificationConfig.PayloadFormat Enum for specifying the format of a notification message's payload.
com.google.storagetransfer.v1.proto.TransferTypes.S3CompatibleMetadata.AuthMethod The authentication and authorization method used by the storage service.
com.google.storagetransfer.v1.proto.TransferTypes.S3CompatibleMetadata.ListApi The Listing API to use for discovering objects.
com.google.storagetransfer.v1.proto.TransferTypes.S3CompatibleMetadata.NetworkProtocol The agent network protocol to access the storage service.
com.google.storagetransfer.v1.proto.TransferTypes.S3CompatibleMetadata.RequestModel The request model of the API.
com.google.storagetransfer.v1.proto.TransferTypes.TransferJob.Status The status of the transfer job.
com.google.storagetransfer.v1.proto.TransferTypes.TransferOperation.Status The status of a TransferOperation.
com.google.storagetransfer.v1.proto.TransferTypes.TransferOptions.OverwriteWhen Specifies when to overwrite an object in the sink when an object with matching name is found in the source.
com.google.storagetransfer.v1.proto.TransferTypes.TransferSpec.DataSinkCase
com.google.storagetransfer.v1.proto.TransferTypes.TransferSpec.DataSourceCase
com.google.storagetransfer.v1.proto.TransferTypes.TransferSpec.IntermediateDataLocationCase