storagetransferpb

package
v1.10.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 14, 2024 License: Apache-2.0 Imports: 17 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	S3CompatibleMetadata_AuthMethod_name = map[int32]string{
		0: "AUTH_METHOD_UNSPECIFIED",
		1: "AUTH_METHOD_AWS_SIGNATURE_V4",
		2: "AUTH_METHOD_AWS_SIGNATURE_V2",
	}
	S3CompatibleMetadata_AuthMethod_value = map[string]int32{
		"AUTH_METHOD_UNSPECIFIED":      0,
		"AUTH_METHOD_AWS_SIGNATURE_V4": 1,
		"AUTH_METHOD_AWS_SIGNATURE_V2": 2,
	}
)

Enum value maps for S3CompatibleMetadata_AuthMethod.

View Source 
var (
	S3CompatibleMetadata_RequestModel_name = map[int32]string{
		0: "REQUEST_MODEL_UNSPECIFIED",
		1: "REQUEST_MODEL_VIRTUAL_HOSTED_STYLE",
		2: "REQUEST_MODEL_PATH_STYLE",
	}
	S3CompatibleMetadata_RequestModel_value = map[string]int32{
		"REQUEST_MODEL_UNSPECIFIED":          0,
		"REQUEST_MODEL_VIRTUAL_HOSTED_STYLE": 1,
		"REQUEST_MODEL_PATH_STYLE":           2,
	}
)

Enum value maps for S3CompatibleMetadata_RequestModel.

View Source 
var (
	S3CompatibleMetadata_NetworkProtocol_name = map[int32]string{
		0: "NETWORK_PROTOCOL_UNSPECIFIED",
		1: "NETWORK_PROTOCOL_HTTPS",
		2: "NETWORK_PROTOCOL_HTTP",
	}
	S3CompatibleMetadata_NetworkProtocol_value = map[string]int32{
		"NETWORK_PROTOCOL_UNSPECIFIED": 0,
		"NETWORK_PROTOCOL_HTTPS":       1,
		"NETWORK_PROTOCOL_HTTP":        2,
	}
)

Enum value maps for S3CompatibleMetadata_NetworkProtocol.

View Source 
var (
	S3CompatibleMetadata_ListApi_name = map[int32]string{
		0: "LIST_API_UNSPECIFIED",
		1: "LIST_OBJECTS_V2",
		2: "LIST_OBJECTS",
	}
	S3CompatibleMetadata_ListApi_value = map[string]int32{
		"LIST_API_UNSPECIFIED": 0,
		"LIST_OBJECTS_V2":      1,
		"LIST_OBJECTS":         2,
	}
)

Enum value maps for S3CompatibleMetadata_ListApi.

View Source 
var (
	AgentPool_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "CREATED",
		3: "DELETING",
	}
	AgentPool_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"CREATED":           2,
		"DELETING":          3,
	}
)

Enum value maps for AgentPool_State.

View Source 
var (
	TransferOptions_OverwriteWhen_name = map[int32]string{
		0: "OVERWRITE_WHEN_UNSPECIFIED",
		1: "DIFFERENT",
		2: "NEVER",
		3: "ALWAYS",
	}
	TransferOptions_OverwriteWhen_value = map[string]int32{
		"OVERWRITE_WHEN_UNSPECIFIED": 0,
		"DIFFERENT":                  1,
		"NEVER":                      2,
		"ALWAYS":                     3,
	}
)

Enum value maps for TransferOptions_OverwriteWhen.

View Source 
var (
	MetadataOptions_Symlink_name = map[int32]string{
		0: "SYMLINK_UNSPECIFIED",
		1: "SYMLINK_SKIP",
		2: "SYMLINK_PRESERVE",
	}
	MetadataOptions_Symlink_value = map[string]int32{
		"SYMLINK_UNSPECIFIED": 0,
		"SYMLINK_SKIP":        1,
		"SYMLINK_PRESERVE":    2,
	}
)

Enum value maps for MetadataOptions_Symlink.

View Source 
var (
	MetadataOptions_Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "MODE_SKIP",
		2: "MODE_PRESERVE",
	}
	MetadataOptions_Mode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"MODE_SKIP":        1,
		"MODE_PRESERVE":    2,
	}
)

Enum value maps for MetadataOptions_Mode.

View Source 
var (
	MetadataOptions_GID_name = map[int32]string{
		0: "GID_UNSPECIFIED",
		1: "GID_SKIP",
		2: "GID_NUMBER",
	}
	MetadataOptions_GID_value = map[string]int32{
		"GID_UNSPECIFIED": 0,
		"GID_SKIP":        1,
		"GID_NUMBER":      2,
	}
)

Enum value maps for MetadataOptions_GID.

View Source 
var (
	MetadataOptions_UID_name = map[int32]string{
		0: "UID_UNSPECIFIED",
		1: "UID_SKIP",
		2: "UID_NUMBER",
	}
	MetadataOptions_UID_value = map[string]int32{
		"UID_UNSPECIFIED": 0,
		"UID_SKIP":        1,
		"UID_NUMBER":      2,
	}
)

Enum value maps for MetadataOptions_UID.

View Source 
var (
	MetadataOptions_Acl_name = map[int32]string{
		0: "ACL_UNSPECIFIED",
		1: "ACL_DESTINATION_BUCKET_DEFAULT",
		2: "ACL_PRESERVE",
	}
	MetadataOptions_Acl_value = map[string]int32{
		"ACL_UNSPECIFIED":                0,
		"ACL_DESTINATION_BUCKET_DEFAULT": 1,
		"ACL_PRESERVE":                   2,
	}
)

Enum value maps for MetadataOptions_Acl.

View Source 
var (
	MetadataOptions_StorageClass_name = map[int32]string{
		0: "STORAGE_CLASS_UNSPECIFIED",
		1: "STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT",
		2: "STORAGE_CLASS_PRESERVE",
		3: "STORAGE_CLASS_STANDARD",
		4: "STORAGE_CLASS_NEARLINE",
		5: "STORAGE_CLASS_COLDLINE",
		6: "STORAGE_CLASS_ARCHIVE",
	}
	MetadataOptions_StorageClass_value = map[string]int32{
		"STORAGE_CLASS_UNSPECIFIED":                0,
		"STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT": 1,
		"STORAGE_CLASS_PRESERVE":                   2,
		"STORAGE_CLASS_STANDARD":                   3,
		"STORAGE_CLASS_NEARLINE":                   4,
		"STORAGE_CLASS_COLDLINE":                   5,
		"STORAGE_CLASS_ARCHIVE":                    6,
	}
)

Enum value maps for MetadataOptions_StorageClass.

View Source 
var (
	MetadataOptions_TemporaryHold_name = map[int32]string{
		0: "TEMPORARY_HOLD_UNSPECIFIED",
		1: "TEMPORARY_HOLD_SKIP",
		2: "TEMPORARY_HOLD_PRESERVE",
	}
	MetadataOptions_TemporaryHold_value = map[string]int32{
		"TEMPORARY_HOLD_UNSPECIFIED": 0,
		"TEMPORARY_HOLD_SKIP":        1,
		"TEMPORARY_HOLD_PRESERVE":    2,
	}
)

Enum value maps for MetadataOptions_TemporaryHold.

View Source 
var (
	MetadataOptions_KmsKey_name = map[int32]string{
		0: "KMS_KEY_UNSPECIFIED",
		1: "KMS_KEY_DESTINATION_BUCKET_DEFAULT",
		2: "KMS_KEY_PRESERVE",
	}
	MetadataOptions_KmsKey_value = map[string]int32{
		"KMS_KEY_UNSPECIFIED":                0,
		"KMS_KEY_DESTINATION_BUCKET_DEFAULT": 1,
		"KMS_KEY_PRESERVE":                   2,
	}
)

Enum value maps for MetadataOptions_KmsKey.

View Source 
var (
	MetadataOptions_TimeCreated_name = map[int32]string{
		0: "TIME_CREATED_UNSPECIFIED",
		1: "TIME_CREATED_SKIP",
		2: "TIME_CREATED_PRESERVE_AS_CUSTOM_TIME",
	}
	MetadataOptions_TimeCreated_value = map[string]int32{
		"TIME_CREATED_UNSPECIFIED":             0,
		"TIME_CREATED_SKIP":                    1,
		"TIME_CREATED_PRESERVE_AS_CUSTOM_TIME": 2,
	}
)

Enum value maps for MetadataOptions_TimeCreated.

View Source 
var (
	TransferJob_Status_name = map[int32]string{
		0: "STATUS_UNSPECIFIED",
		1: "ENABLED",
		2: "DISABLED",
		3: "DELETED",
	}
	TransferJob_Status_value = map[string]int32{
		"STATUS_UNSPECIFIED": 0,
		"ENABLED":            1,
		"DISABLED":           2,
		"DELETED":            3,
	}
)

Enum value maps for TransferJob_Status.

View Source 
var (
	NotificationConfig_EventType_name = map[int32]string{
		0: "EVENT_TYPE_UNSPECIFIED",
		1: "TRANSFER_OPERATION_SUCCESS",
		2: "TRANSFER_OPERATION_FAILED",
		3: "TRANSFER_OPERATION_ABORTED",
	}
	NotificationConfig_EventType_value = map[string]int32{
		"EVENT_TYPE_UNSPECIFIED":     0,
		"TRANSFER_OPERATION_SUCCESS": 1,
		"TRANSFER_OPERATION_FAILED":  2,
		"TRANSFER_OPERATION_ABORTED": 3,
	}
)

Enum value maps for NotificationConfig_EventType.

View Source 
var (
	NotificationConfig_PayloadFormat_name = map[int32]string{
		0: "PAYLOAD_FORMAT_UNSPECIFIED",
		1: "NONE",
		2: "JSON",
	}
	NotificationConfig_PayloadFormat_value = map[string]int32{
		"PAYLOAD_FORMAT_UNSPECIFIED": 0,
		"NONE":                       1,
		"JSON":                       2,
	}
)

Enum value maps for NotificationConfig_PayloadFormat.

View Source 
var (
	LoggingConfig_LoggableAction_name = map[int32]string{
		0: "LOGGABLE_ACTION_UNSPECIFIED",
		1: "FIND",
		2: "DELETE",
		3: "COPY",
	}
	LoggingConfig_LoggableAction_value = map[string]int32{
		"LOGGABLE_ACTION_UNSPECIFIED": 0,
		"FIND":                        1,
		"DELETE":                      2,
		"COPY":                        3,
	}
)

Enum value maps for LoggingConfig_LoggableAction.

View Source 
var (
	LoggingConfig_LoggableActionState_name = map[int32]string{
		0: "LOGGABLE_ACTION_STATE_UNSPECIFIED",
		1: "SUCCEEDED",
		2: "FAILED",
	}
	LoggingConfig_LoggableActionState_value = map[string]int32{
		"LOGGABLE_ACTION_STATE_UNSPECIFIED": 0,
		"SUCCEEDED":                         1,
		"FAILED":                            2,
	}
)

Enum value maps for LoggingConfig_LoggableActionState.

View Source 
var (
	TransferOperation_Status_name = map[int32]string{
		0: "STATUS_UNSPECIFIED",
		1: "IN_PROGRESS",
		2: "PAUSED",
		3: "SUCCESS",
		4: "FAILED",
		5: "ABORTED",
		6: "QUEUED",
		7: "SUSPENDING",
	}
	TransferOperation_Status_value = map[string]int32{
		"STATUS_UNSPECIFIED": 0,
		"IN_PROGRESS":        1,
		"PAUSED":             2,
		"SUCCESS":            3,
		"FAILED":             4,
		"ABORTED":            5,
		"QUEUED":             6,
		"SUSPENDING":         7,
	}
)

Enum value maps for TransferOperation_Status.

View Source 
var File_google_storagetransfer_v1_transfer_proto protoreflect.FileDescriptor
View Source 
var File_google_storagetransfer_v1_transfer_types_proto protoreflect.FileDescriptor

Functions

func RegisterStorageTransferServiceServer 

func RegisterStorageTransferServiceServer(s *grpc.Server, srv StorageTransferServiceServer)

Types

type AgentPool 

type AgentPool struct {

	// Required. Specifies a unique string that identifies the agent pool.
	//
	// Format: `projects/{project_id}/agentPools/{agent_pool_id}`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Specifies the client-specified AgentPool description.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. Specifies the state of the AgentPool.
	State AgentPool_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.storagetransfer.v1.AgentPool_State" json:"state,omitempty"`
	// Specifies the bandwidth limit details. If this field is unspecified, the
	// default value is set as 'No Limit'.
	BandwidthLimit *AgentPool_BandwidthLimit `protobuf:"bytes,5,opt,name=bandwidth_limit,json=bandwidthLimit,proto3" json:"bandwidth_limit,omitempty"`
	// contains filtered or unexported fields
}

Represents an On-Premises Agent pool.

func (*AgentPool) Descriptor deprecated 

func (*AgentPool) Descriptor() ([]byte, []int)

Deprecated: Use AgentPool.ProtoReflect.Descriptor instead.

func (*AgentPool) GetBandwidthLimit 

func (x *AgentPool) GetBandwidthLimit() *AgentPool_BandwidthLimit

func (*AgentPool) GetDisplayName 

func (x *AgentPool) GetDisplayName() string

func (*AgentPool) GetName 

func (x *AgentPool) GetName() string

func (*AgentPool) GetState 

func (x *AgentPool) GetState() AgentPool_State

func (*AgentPool) ProtoMessage 

func (*AgentPool) ProtoMessage()

func (*AgentPool) ProtoReflect 

func (x *AgentPool) ProtoReflect() protoreflect.Message

func (*AgentPool) Reset 

func (x *AgentPool) Reset()

func (*AgentPool) String 

func (x *AgentPool) String() string

type AgentPool_BandwidthLimit 

type AgentPool_BandwidthLimit struct {

	// Bandwidth rate in megabytes per second, distributed across all the agents
	// in the pool.
	LimitMbps int64 `protobuf:"varint,1,opt,name=limit_mbps,json=limitMbps,proto3" json:"limit_mbps,omitempty"`
	// contains filtered or unexported fields
}

Specifies a bandwidth limit for an agent pool.

func (*AgentPool_BandwidthLimit) Descriptor deprecated 

func (*AgentPool_BandwidthLimit) Descriptor() ([]byte, []int)

Deprecated: Use AgentPool_BandwidthLimit.ProtoReflect.Descriptor instead.

func (*AgentPool_BandwidthLimit) GetLimitMbps 

func (x *AgentPool_BandwidthLimit) GetLimitMbps() int64

func (*AgentPool_BandwidthLimit) ProtoMessage 

func (*AgentPool_BandwidthLimit) ProtoMessage()

func (*AgentPool_BandwidthLimit) ProtoReflect 

func (x *AgentPool_BandwidthLimit) ProtoReflect() protoreflect.Message

func (*AgentPool_BandwidthLimit) Reset 

func (x *AgentPool_BandwidthLimit) Reset()

func (*AgentPool_BandwidthLimit) String 

func (x *AgentPool_BandwidthLimit) String() string

type AgentPool_State 

type AgentPool_State int32

The state of an AgentPool. 

const (
	// Default value. This value is unused.
	AgentPool_STATE_UNSPECIFIED AgentPool_State = 0
	// This is an initialization state. During this stage, the resources such as
	// Pub/Sub topics are allocated for the AgentPool.
	AgentPool_CREATING AgentPool_State = 1
	// Determines that the AgentPool is created for use. At this state, Agents
	// can join the AgentPool and participate in the transfer jobs in that pool.
	AgentPool_CREATED AgentPool_State = 2
	// Determines that the AgentPool deletion has been initiated, and all the
	// resources are scheduled to be cleaned up and freed.
	AgentPool_DELETING AgentPool_State = 3
)

func (AgentPool_State) Descriptor 

func (AgentPool_State) Descriptor() protoreflect.EnumDescriptor

func (AgentPool_State) Enum 

func (x AgentPool_State) Enum() *AgentPool_State

func (AgentPool_State) EnumDescriptor deprecated 

func (AgentPool_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use AgentPool_State.Descriptor instead.

func (AgentPool_State) Number 

func (x AgentPool_State) Number() protoreflect.EnumNumber

func (AgentPool_State) String 

func (x AgentPool_State) String() string

func (AgentPool_State) Type 

func (AgentPool_State) Type() protoreflect.EnumType

type AwsAccessKey 

type AwsAccessKey struct {

	// Required. AWS access key ID.
	AccessKeyId string `protobuf:"bytes,1,opt,name=access_key_id,json=accessKeyId,proto3" json:"access_key_id,omitempty"`
	// Required. AWS secret access key. This field is not returned in RPC
	// responses.
	SecretAccessKey string `protobuf:"bytes,2,opt,name=secret_access_key,json=secretAccessKey,proto3" json:"secret_access_key,omitempty"`
	// contains filtered or unexported fields
}

AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).

For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials).

func (*AwsAccessKey) Descriptor deprecated 

func (*AwsAccessKey) Descriptor() ([]byte, []int)

Deprecated: Use AwsAccessKey.ProtoReflect.Descriptor instead.

func (*AwsAccessKey) GetAccessKeyId 

func (x *AwsAccessKey) GetAccessKeyId() string

func (*AwsAccessKey) GetSecretAccessKey 

func (x *AwsAccessKey) GetSecretAccessKey() string

func (*AwsAccessKey) ProtoMessage 

func (*AwsAccessKey) ProtoMessage()

func (*AwsAccessKey) ProtoReflect 

func (x *AwsAccessKey) ProtoReflect() protoreflect.Message

func (*AwsAccessKey) Reset 

func (x *AwsAccessKey) Reset()

func (*AwsAccessKey) String 

func (x *AwsAccessKey) String() string

type AwsS3CompatibleData 

type AwsS3CompatibleData struct {

	// Required. Specifies the name of the bucket.
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// Specifies the root path to transfer objects.
	//
	// Must be an empty string or full path name that ends with a '/'. This
	// field is treated as an object prefix. As such, it should generally not
	// begin with a '/'.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// Required. Specifies the endpoint of the storage service.
	Endpoint string `protobuf:"bytes,3,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Specifies the region to sign requests with. This can be left blank if
	// requests should be signed with an empty region.
	Region string `protobuf:"bytes,5,opt,name=region,proto3" json:"region,omitempty"`
	// Specifies the metadata of the S3 compatible data provider. Each provider
	// may contain some attributes that do not apply to all S3-compatible data
	// providers. When not specified, S3CompatibleMetadata is used by default.
	//
	// Types that are assignable to DataProvider:
	//
	//	*AwsS3CompatibleData_S3Metadata
	DataProvider isAwsS3CompatibleData_DataProvider `protobuf_oneof:"data_provider"`
	// contains filtered or unexported fields
}

An AwsS3CompatibleData resource.

func (*AwsS3CompatibleData) Descriptor deprecated 

func (*AwsS3CompatibleData) Descriptor() ([]byte, []int)

Deprecated: Use AwsS3CompatibleData.ProtoReflect.Descriptor instead.

func (*AwsS3CompatibleData) GetBucketName 

func (x *AwsS3CompatibleData) GetBucketName() string

func (*AwsS3CompatibleData) GetDataProvider 

func (m *AwsS3CompatibleData) GetDataProvider() isAwsS3CompatibleData_DataProvider

func (*AwsS3CompatibleData) GetEndpoint 

func (x *AwsS3CompatibleData) GetEndpoint() string

func (*AwsS3CompatibleData) GetPath 

func (x *AwsS3CompatibleData) GetPath() string

func (*AwsS3CompatibleData) GetRegion 

func (x *AwsS3CompatibleData) GetRegion() string

func (*AwsS3CompatibleData) GetS3Metadata 

func (x *AwsS3CompatibleData) GetS3Metadata() *S3CompatibleMetadata

func (*AwsS3CompatibleData) ProtoMessage 

func (*AwsS3CompatibleData) ProtoMessage()

func (*AwsS3CompatibleData) ProtoReflect 

func (x *AwsS3CompatibleData) ProtoReflect() protoreflect.Message

func (*AwsS3CompatibleData) Reset 

func (x *AwsS3CompatibleData) Reset()

func (*AwsS3CompatibleData) String 

func (x *AwsS3CompatibleData) String() string

type AwsS3CompatibleData_S3Metadata 

type AwsS3CompatibleData_S3Metadata struct {
	// A S3 compatible metadata.
	S3Metadata *S3CompatibleMetadata `protobuf:"bytes,4,opt,name=s3_metadata,json=s3Metadata,proto3,oneof"`
}

type AwsS3Data 

type AwsS3Data struct {

	// Required. S3 Bucket name (see
	// [Creating a
	// bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// Input only. AWS access key used to sign the API requests to the AWS S3
	// bucket. Permissions on the bucket must be granted to the access ID of the
	// AWS access key.
	//
	// For information on our data retention policy for user credentials, see
	// [User credentials](/storage-transfer/docs/data-retention#user-credentials).
	AwsAccessKey *AwsAccessKey `protobuf:"bytes,2,opt,name=aws_access_key,json=awsAccessKey,proto3" json:"aws_access_key,omitempty"`
	// Root path to transfer objects.
	//
	// Must be an empty string or full path name that ends with a '/'. This field
	// is treated as an object prefix. As such, it should generally not begin with
	// a '/'.
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// The Amazon Resource Name (ARN) of the role to support temporary
	// credentials via `AssumeRoleWithWebIdentity`. For more information about
	// ARNs, see [IAM
	// ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	//
	// When a role ARN is provided, Transfer Service fetches temporary
	// credentials for the session using a `AssumeRoleWithWebIdentity` call for
	// the provided role using the
	// [GoogleServiceAccount][google.storagetransfer.v1.GoogleServiceAccount] for
	// this project.
	RoleArn string `protobuf:"bytes,4,opt,name=role_arn,json=roleArn,proto3" json:"role_arn,omitempty"`
	// Optional. The Resource name of a secret in Secret Manager.
	//
	// The Azure SAS token must be stored in Secret Manager in JSON format:
	//
	//	<pre>{
	//	 "sas_token" : "<var>SAS_TOKEN</var>"
	//	}</pre>
	//
	// [GoogleServiceAccount][google.storagetransfer.v1.GoogleServiceAccount] must
	// be granted `roles/secretmanager.secretAccessor` for the resource.
	//
	// See [Configure access to a source: Microsoft Azure Blob Storage]
	// (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)
	// for more information.
	//
	// If `credentials_secret` is specified, do not specify [azure_credentials][].
	//
	// This feature is in
	// [preview](https://cloud.google.com/terms/service-terms#1).
	//
	// Format: `projects/{project_number}/secrets/{secret_name}`
	CredentialsSecret string `protobuf:"bytes,7,opt,name=credentials_secret,json=credentialsSecret,proto3" json:"credentials_secret,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*AwsS3Data) Descriptor deprecated 

func (*AwsS3Data) Descriptor() ([]byte, []int)

Deprecated: Use AwsS3Data.ProtoReflect.Descriptor instead.

func (*AwsS3Data) GetAwsAccessKey 

func (x *AwsS3Data) GetAwsAccessKey() *AwsAccessKey

func (*AwsS3Data) GetBucketName 

func (x *AwsS3Data) GetBucketName() string

func (*AwsS3Data) GetCredentialsSecret added in v1.10.0 

func (x *AwsS3Data) GetCredentialsSecret() string

func (*AwsS3Data) GetPath 

func (x *AwsS3Data) GetPath() string

func (*AwsS3Data) GetRoleArn 

func (x *AwsS3Data) GetRoleArn() string

func (*AwsS3Data) ProtoMessage 

func (*AwsS3Data) ProtoMessage()

func (*AwsS3Data) ProtoReflect 

func (x *AwsS3Data) ProtoReflect() protoreflect.Message

func (*AwsS3Data) Reset 

func (x *AwsS3Data) Reset()

func (*AwsS3Data) String 

func (x *AwsS3Data) String() string

type AzureBlobStorageData 

type AzureBlobStorageData struct {

	// Required. The name of the Azure Storage account.
	StorageAccount string `protobuf:"bytes,1,opt,name=storage_account,json=storageAccount,proto3" json:"storage_account,omitempty"`
	// Required. Input only. Credentials used to authenticate API requests to
	// Azure.
	//
	// For information on our data retention policy for user credentials, see
	// [User credentials](/storage-transfer/docs/data-retention#user-credentials).
	AzureCredentials *AzureCredentials `protobuf:"bytes,2,opt,name=azure_credentials,json=azureCredentials,proto3" json:"azure_credentials,omitempty"`
	// Required. The container to transfer from the Azure Storage account.
	Container string `protobuf:"bytes,4,opt,name=container,proto3" json:"container,omitempty"`
	// Root path to transfer objects.
	//
	// Must be an empty string or full path name that ends with a '/'. This field
	// is treated as an object prefix. As such, it should generally not begin with
	// a '/'.
	Path string `protobuf:"bytes,5,opt,name=path,proto3" json:"path,omitempty"`
	// Optional. The Resource name of a secret in Secret Manager.
	//
	// The Azure SAS token must be stored in Secret Manager in JSON format:
	//
	//	<pre>{
	//	 "sas_token" : "<var>SAS_TOKEN</var>"
	//	}</pre>
	//
	// [GoogleServiceAccount][google.storagetransfer.v1.GoogleServiceAccount] must
	// be granted `roles/secretmanager.secretAccessor` for the resource.
	//
	// See [Configure access to a source: Microsoft Azure Blob Storage]
	// (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager)
	// for more information.
	//
	// If `credentials_secret` is specified, do not specify
	// [azure_credentials][google.storagetransfer.v1.AzureBlobStorageData.azure_credentials].
	//
	// This feature is in
	// [preview](https://cloud.google.com/terms/service-terms#1).
	//
	// Format: `projects/{project_number}/secrets/{secret_name}`
	CredentialsSecret string `protobuf:"bytes,7,opt,name=credentials_secret,json=credentialsSecret,proto3" json:"credentials_secret,omitempty"`
	// contains filtered or unexported fields
}

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 endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints). In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names).

func (*AzureBlobStorageData) Descriptor deprecated 

func (*AzureBlobStorageData) Descriptor() ([]byte, []int)

Deprecated: Use AzureBlobStorageData.ProtoReflect.Descriptor instead.

func (*AzureBlobStorageData) GetAzureCredentials 

func (x *AzureBlobStorageData) GetAzureCredentials() *AzureCredentials

func (*AzureBlobStorageData) GetContainer 

func (x *AzureBlobStorageData) GetContainer() string

func (*AzureBlobStorageData) GetCredentialsSecret added in v1.10.0 

func (x *AzureBlobStorageData) GetCredentialsSecret() string

func (*AzureBlobStorageData) GetPath 

func (x *AzureBlobStorageData) GetPath() string

func (*AzureBlobStorageData) GetStorageAccount 

func (x *AzureBlobStorageData) GetStorageAccount() string

func (*AzureBlobStorageData) ProtoMessage 

func (*AzureBlobStorageData) ProtoMessage()

func (*AzureBlobStorageData) ProtoReflect 

func (x *AzureBlobStorageData) ProtoReflect() protoreflect.Message

func (*AzureBlobStorageData) Reset 

func (x *AzureBlobStorageData) Reset()

func (*AzureBlobStorageData) String 

func (x *AzureBlobStorageData) String() string

type AzureCredentials 

type AzureCredentials struct {

	// Required. Azure shared access signature (SAS).
	//
	// For more information about SAS, see
	// [Grant limited access to Azure Storage resources using shared access
	// signatures
	// (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview).
	SasToken string `protobuf:"bytes,2,opt,name=sas_token,json=sasToken,proto3" json:"sas_token,omitempty"`
	// contains filtered or unexported fields
}

Azure credentials

For information on our data retention policy for user credentials, see [User credentials](/storage-transfer/docs/data-retention#user-credentials).

func (*AzureCredentials) Descriptor deprecated 

func (*AzureCredentials) Descriptor() ([]byte, []int)

Deprecated: Use AzureCredentials.ProtoReflect.Descriptor instead.

func (*AzureCredentials) GetSasToken 

func (x *AzureCredentials) GetSasToken() string

func (*AzureCredentials) ProtoMessage 

func (*AzureCredentials) ProtoMessage()

func (*AzureCredentials) ProtoReflect 

func (x *AzureCredentials) ProtoReflect() protoreflect.Message

func (*AzureCredentials) Reset 

func (x *AzureCredentials) Reset()

func (*AzureCredentials) String 

func (x *AzureCredentials) String() string

type CreateAgentPoolRequest 

type CreateAgentPoolRequest struct {

	// Required. The ID of the Google Cloud project that owns the
	// agent pool.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The agent pool to create.
	AgentPool *AgentPool `protobuf:"bytes,2,opt,name=agent_pool,json=agentPool,proto3" json:"agent_pool,omitempty"`
	// 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])?$`.
	AgentPoolId string `protobuf:"bytes,3,opt,name=agent_pool_id,json=agentPoolId,proto3" json:"agent_pool_id,omitempty"`
	// contains filtered or unexported fields
}

Specifies the request passed to CreateAgentPool.

func (*CreateAgentPoolRequest) Descriptor deprecated 

func (*CreateAgentPoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateAgentPoolRequest.ProtoReflect.Descriptor instead.

func (*CreateAgentPoolRequest) GetAgentPool 

func (x *CreateAgentPoolRequest) GetAgentPool() *AgentPool

func (*CreateAgentPoolRequest) GetAgentPoolId 

func (x *CreateAgentPoolRequest) GetAgentPoolId() string

func (*CreateAgentPoolRequest) GetProjectId 

func (x *CreateAgentPoolRequest) GetProjectId() string

func (*CreateAgentPoolRequest) ProtoMessage 

func (*CreateAgentPoolRequest) ProtoMessage()

func (*CreateAgentPoolRequest) ProtoReflect 

func (x *CreateAgentPoolRequest) ProtoReflect() protoreflect.Message

func (*CreateAgentPoolRequest) Reset 

func (x *CreateAgentPoolRequest) Reset()

func (*CreateAgentPoolRequest) String 

func (x *CreateAgentPoolRequest) String() string

type CreateTransferJobRequest 

type CreateTransferJobRequest struct {

	// Required. The job to create.
	TransferJob *TransferJob `protobuf:"bytes,1,opt,name=transfer_job,json=transferJob,proto3" json:"transfer_job,omitempty"`
	// contains filtered or unexported fields
}

Request passed to CreateTransferJob.

func (*CreateTransferJobRequest) Descriptor deprecated 

func (*CreateTransferJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTransferJobRequest.ProtoReflect.Descriptor instead.

func (*CreateTransferJobRequest) GetTransferJob 

func (x *CreateTransferJobRequest) GetTransferJob() *TransferJob

func (*CreateTransferJobRequest) ProtoMessage 

func (*CreateTransferJobRequest) ProtoMessage()

func (*CreateTransferJobRequest) ProtoReflect 

func (x *CreateTransferJobRequest) ProtoReflect() protoreflect.Message

func (*CreateTransferJobRequest) Reset 

func (x *CreateTransferJobRequest) Reset()

func (*CreateTransferJobRequest) String 

func (x *CreateTransferJobRequest) String() string

type DeleteAgentPoolRequest 

type DeleteAgentPoolRequest struct {

	// Required. The name of the agent pool to delete.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Specifies the request passed to DeleteAgentPool.

func (*DeleteAgentPoolRequest) Descriptor deprecated 

func (*DeleteAgentPoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteAgentPoolRequest.ProtoReflect.Descriptor instead.

func (*DeleteAgentPoolRequest) GetName 

func (x *DeleteAgentPoolRequest) GetName() string

func (*DeleteAgentPoolRequest) ProtoMessage 

func (*DeleteAgentPoolRequest) ProtoMessage()

func (*DeleteAgentPoolRequest) ProtoReflect 

func (x *DeleteAgentPoolRequest) ProtoReflect() protoreflect.Message

func (*DeleteAgentPoolRequest) Reset 

func (x *DeleteAgentPoolRequest) Reset()

func (*DeleteAgentPoolRequest) String 

func (x *DeleteAgentPoolRequest) String() string

type DeleteTransferJobRequest 

type DeleteTransferJobRequest struct {

	// Required. The job to delete.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// Required. The ID of the Google Cloud project that owns the
	// job.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// contains filtered or unexported fields
}

Request passed to DeleteTransferJob.

func (*DeleteTransferJobRequest) Descriptor deprecated 

func (*DeleteTransferJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTransferJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteTransferJobRequest) GetJobName 

func (x *DeleteTransferJobRequest) GetJobName() string

func (*DeleteTransferJobRequest) GetProjectId 

func (x *DeleteTransferJobRequest) GetProjectId() string

func (*DeleteTransferJobRequest) ProtoMessage 

func (*DeleteTransferJobRequest) ProtoMessage()

func (*DeleteTransferJobRequest) ProtoReflect 

func (x *DeleteTransferJobRequest) ProtoReflect() protoreflect.Message

func (*DeleteTransferJobRequest) Reset 

func (x *DeleteTransferJobRequest) Reset()

func (*DeleteTransferJobRequest) String 

func (x *DeleteTransferJobRequest) String() string

type ErrorLogEntry 

type ErrorLogEntry struct {

	// Required. A URL that refers to the target (a data source, a data sink,
	// or an object) with which the error is associated.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// A list of messages that carry the error details.
	ErrorDetails []string `protobuf:"bytes,3,rep,name=error_details,json=errorDetails,proto3" json:"error_details,omitempty"`
	// contains filtered or unexported fields
}

An entry describing an error that has occurred.

func (*ErrorLogEntry) Descriptor deprecated 

func (*ErrorLogEntry) Descriptor() ([]byte, []int)

Deprecated: Use ErrorLogEntry.ProtoReflect.Descriptor instead.

func (*ErrorLogEntry) GetErrorDetails 

func (x *ErrorLogEntry) GetErrorDetails() []string

func (*ErrorLogEntry) GetUrl 

func (x *ErrorLogEntry) GetUrl() string

func (*ErrorLogEntry) ProtoMessage 

func (*ErrorLogEntry) ProtoMessage()

func (*ErrorLogEntry) ProtoReflect 

func (x *ErrorLogEntry) ProtoReflect() protoreflect.Message

func (*ErrorLogEntry) Reset 

func (x *ErrorLogEntry) Reset()

func (*ErrorLogEntry) String 

func (x *ErrorLogEntry) String() string

type ErrorSummary 

type ErrorSummary struct {

	// Required.
	ErrorCode code.Code `protobuf:"varint,1,opt,name=error_code,json=errorCode,proto3,enum=google.rpc.Code" json:"error_code,omitempty"`
	// Required. Count of this type of error.
	ErrorCount int64 `protobuf:"varint,2,opt,name=error_count,json=errorCount,proto3" json:"error_count,omitempty"`
	// Error samples.
	//
	// At most 5 error log entries are recorded for a given
	// error code for a single transfer operation.
	ErrorLogEntries []*ErrorLogEntry `protobuf:"bytes,3,rep,name=error_log_entries,json=errorLogEntries,proto3" json:"error_log_entries,omitempty"`
	// contains filtered or unexported fields
}

A summary of errors by error code, plus a count and sample error log entries.

func (*ErrorSummary) Descriptor deprecated 

func (*ErrorSummary) Descriptor() ([]byte, []int)

Deprecated: Use ErrorSummary.ProtoReflect.Descriptor instead.

func (*ErrorSummary) GetErrorCode 

func (x *ErrorSummary) GetErrorCode() code.Code

func (*ErrorSummary) GetErrorCount 

func (x *ErrorSummary) GetErrorCount() int64

func (*ErrorSummary) GetErrorLogEntries 

func (x *ErrorSummary) GetErrorLogEntries() []*ErrorLogEntry

func (*ErrorSummary) ProtoMessage 

func (*ErrorSummary) ProtoMessage()

func (*ErrorSummary) ProtoReflect 

func (x *ErrorSummary) ProtoReflect() protoreflect.Message

func (*ErrorSummary) Reset 

func (x *ErrorSummary) Reset()

func (*ErrorSummary) String 

func (x *ErrorSummary) String() string

type EventStream added in v1.10.0 

type EventStream struct {

	// Required. Specifies a unique name of the resource such as AWS SQS
	// ARN in the form 'arn:aws:sqs:region:account_id:queue_name',
	// or Pub/Sub subscription resource name in the form
	// 'projects/{project}/subscriptions/{sub}'.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Specifies the date and time that Storage Transfer Service starts
	// listening for events from this stream. If no start time is specified or
	// start time is in the past, Storage Transfer Service starts listening
	// immediately.
	EventStreamStartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=event_stream_start_time,json=eventStreamStartTime,proto3" json:"event_stream_start_time,omitempty"`
	// Specifies the data and time at which Storage Transfer Service stops
	// listening for events from this stream. After this time, any transfers in
	// progress will complete, but no new transfers are initiated.
	EventStreamExpirationTime *timestamppb.Timestamp `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.

func (*EventStream) Descriptor deprecated added in v1.10.0 

func (*EventStream) Descriptor() ([]byte, []int)

Deprecated: Use EventStream.ProtoReflect.Descriptor instead.

func (*EventStream) GetEventStreamExpirationTime added in v1.10.0 

func (x *EventStream) GetEventStreamExpirationTime() *timestamppb.Timestamp

func (*EventStream) GetEventStreamStartTime added in v1.10.0 

func (x *EventStream) GetEventStreamStartTime() *timestamppb.Timestamp

func (*EventStream) GetName added in v1.10.0 

func (x *EventStream) GetName() string

func (*EventStream) ProtoMessage added in v1.10.0 

func (*EventStream) ProtoMessage()

func (*EventStream) ProtoReflect added in v1.10.0 

func (x *EventStream) ProtoReflect() protoreflect.Message

func (*EventStream) Reset added in v1.10.0 

func (x *EventStream) Reset()

func (*EventStream) String added in v1.10.0 

func (x *EventStream) String() string

type GcsData 

type GcsData struct {

	// Required. Cloud Storage bucket name. Must meet
	// [Bucket Name Requirements](/storage/docs/naming#requirements).
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// Root path to transfer objects.
	//
	// Must be an empty string or full path name that ends with a '/'. This field
	// is treated as an object prefix. As such, it should generally not begin with
	// a '/'.
	//
	// The root path value must meet
	// [Object Name Requirements](/storage/docs/naming#objectnames).
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*GcsData) Descriptor deprecated 

func (*GcsData) Descriptor() ([]byte, []int)

Deprecated: Use GcsData.ProtoReflect.Descriptor instead.

func (*GcsData) GetBucketName 

func (x *GcsData) GetBucketName() string

func (*GcsData) GetPath 

func (x *GcsData) GetPath() string

func (*GcsData) ProtoMessage 

func (*GcsData) ProtoMessage()

func (*GcsData) ProtoReflect 

func (x *GcsData) ProtoReflect() protoreflect.Message

func (*GcsData) Reset 

func (x *GcsData) Reset()

func (*GcsData) String 

func (x *GcsData) String() string

type GetAgentPoolRequest 

type GetAgentPoolRequest struct {

	// Required. The name of the agent pool to get.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Specifies the request passed to GetAgentPool.

func (*GetAgentPoolRequest) Descriptor deprecated 

func (*GetAgentPoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAgentPoolRequest.ProtoReflect.Descriptor instead.

func (*GetAgentPoolRequest) GetName 

func (x *GetAgentPoolRequest) GetName() string

func (*GetAgentPoolRequest) ProtoMessage 

func (*GetAgentPoolRequest) ProtoMessage()

func (*GetAgentPoolRequest) ProtoReflect 

func (x *GetAgentPoolRequest) ProtoReflect() protoreflect.Message

func (*GetAgentPoolRequest) Reset 

func (x *GetAgentPoolRequest) Reset()

func (*GetAgentPoolRequest) String 

func (x *GetAgentPoolRequest) String() string

type GetGoogleServiceAccountRequest 

type GetGoogleServiceAccountRequest struct {

	// Required. The ID of the Google Cloud project that the Google service
	// account is associated with.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// contains filtered or unexported fields
}

Request passed to GetGoogleServiceAccount.

func (*GetGoogleServiceAccountRequest) Descriptor deprecated 

func (*GetGoogleServiceAccountRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetGoogleServiceAccountRequest.ProtoReflect.Descriptor instead.

func (*GetGoogleServiceAccountRequest) GetProjectId 

func (x *GetGoogleServiceAccountRequest) GetProjectId() string

func (*GetGoogleServiceAccountRequest) ProtoMessage 

func (*GetGoogleServiceAccountRequest) ProtoMessage()

func (*GetGoogleServiceAccountRequest) ProtoReflect 

func (x *GetGoogleServiceAccountRequest) ProtoReflect() protoreflect.Message

func (*GetGoogleServiceAccountRequest) Reset 

func (x *GetGoogleServiceAccountRequest) Reset()

func (*GetGoogleServiceAccountRequest) String 

func (x *GetGoogleServiceAccountRequest) String() string

type GetTransferJobRequest 

type GetTransferJobRequest struct {

	// Required. The job to get.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// Required. The ID of the Google Cloud project that owns the
	// job.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// contains filtered or unexported fields
}

Request passed to GetTransferJob.

func (*GetTransferJobRequest) Descriptor deprecated 

func (*GetTransferJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTransferJobRequest.ProtoReflect.Descriptor instead.

func (*GetTransferJobRequest) GetJobName 

func (x *GetTransferJobRequest) GetJobName() string

func (*GetTransferJobRequest) GetProjectId 

func (x *GetTransferJobRequest) GetProjectId() string

func (*GetTransferJobRequest) ProtoMessage 

func (*GetTransferJobRequest) ProtoMessage()

func (*GetTransferJobRequest) ProtoReflect 

func (x *GetTransferJobRequest) ProtoReflect() protoreflect.Message

func (*GetTransferJobRequest) Reset 

func (x *GetTransferJobRequest) Reset()

func (*GetTransferJobRequest) String 

func (x *GetTransferJobRequest) String() string

type GoogleServiceAccount 

type GoogleServiceAccount struct {

	// Email address of the service account.
	AccountEmail string `protobuf:"bytes,1,opt,name=account_email,json=accountEmail,proto3" json:"account_email,omitempty"`
	// Unique identifier for the service account.
	SubjectId string `protobuf:"bytes,2,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	// contains filtered or unexported fields
}

Google service account

func (*GoogleServiceAccount) Descriptor deprecated 

func (*GoogleServiceAccount) Descriptor() ([]byte, []int)

Deprecated: Use GoogleServiceAccount.ProtoReflect.Descriptor instead.

func (*GoogleServiceAccount) GetAccountEmail 

func (x *GoogleServiceAccount) GetAccountEmail() string

func (*GoogleServiceAccount) GetSubjectId 

func (x *GoogleServiceAccount) GetSubjectId() string

func (*GoogleServiceAccount) ProtoMessage 

func (*GoogleServiceAccount) ProtoMessage()

func (*GoogleServiceAccount) ProtoReflect 

func (x *GoogleServiceAccount) ProtoReflect() protoreflect.Message

func (*GoogleServiceAccount) Reset 

func (x *GoogleServiceAccount) Reset()

func (*GoogleServiceAccount) String 

func (x *GoogleServiceAccount) String() string

type HttpData 

type HttpData struct {

	// Required. The URL that points to the file that stores the object list
	// entries. This file must allow public access.  Currently, only URLs with
	// HTTP and HTTPS schemes are supported.
	ListUrl string `protobuf:"bytes,1,opt,name=list_url,json=listUrl,proto3" json:"list_url,omitempty"`
	// contains filtered or unexported fields
}

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 `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields:

* **HTTP URL** — The location of the object.

* **Length** — The size of the object in bytes.

* **MD5** — The base64-encoded MD5 hash of the object.

For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list).

When transferring data based on a URL list, keep the following in mind:

* When an object located at `http(s)://hostname:port/<URL-path>` is transferred to a data sink, the name of the object at the data sink is `<hostname>/<URL-path>`.

* If the specified size of an object does not match the actual size of the object fetched, the object is not transferred.

* If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer fails.

* Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (/storage/docs/cloud-console#_sharingdata) and get a link to it.

* Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response.

* ObjectConditions[google.storagetransfer.v1.ObjectConditions] have no effect when filtering objects to transfer.

func (*HttpData) Descriptor deprecated 

func (*HttpData) Descriptor() ([]byte, []int)

Deprecated: Use HttpData.ProtoReflect.Descriptor instead.

func (*HttpData) GetListUrl 

func (x *HttpData) GetListUrl() string

func (*HttpData) ProtoMessage 

func (*HttpData) ProtoMessage()

func (*HttpData) ProtoReflect 

func (x *HttpData) ProtoReflect() protoreflect.Message

func (*HttpData) Reset 

func (x *HttpData) Reset()

func (*HttpData) String 

func (x *HttpData) String() string

type ListAgentPoolsRequest 

type ListAgentPoolsRequest struct {

	// Required. The ID of the Google Cloud project that owns the job.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// An optional list of query parameters specified as JSON text in the
	// form of:
	//
	// `{"agentPoolNames":["agentpool1","agentpool2",...]}`
	//
	// Since `agentPoolNames` support multiple values, its values must be
	// specified with array notation. When the filter is either empty or not
	// provided, the list returns all agent pools for the project.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// The list page size. The max allowed value is `256`.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The list page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request passed to ListAgentPools.

func (*ListAgentPoolsRequest) Descriptor deprecated 

func (*ListAgentPoolsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAgentPoolsRequest.ProtoReflect.Descriptor instead.

func (*ListAgentPoolsRequest) GetFilter 

func (x *ListAgentPoolsRequest) GetFilter() string

func (*ListAgentPoolsRequest) GetPageSize 

func (x *ListAgentPoolsRequest) GetPageSize() int32

func (*ListAgentPoolsRequest) GetPageToken 

func (x *ListAgentPoolsRequest) GetPageToken() string

func (*ListAgentPoolsRequest) GetProjectId 

func (x *ListAgentPoolsRequest) GetProjectId() string

func (*ListAgentPoolsRequest) ProtoMessage 

func (*ListAgentPoolsRequest) ProtoMessage()

func (*ListAgentPoolsRequest) ProtoReflect 

func (x *ListAgentPoolsRequest) ProtoReflect() protoreflect.Message

func (*ListAgentPoolsRequest) Reset 

func (x *ListAgentPoolsRequest) Reset()

func (*ListAgentPoolsRequest) String 

func (x *ListAgentPoolsRequest) String() string

type ListAgentPoolsResponse 

type ListAgentPoolsResponse struct {

	// A list of agent pools.
	AgentPools []*AgentPool `protobuf:"bytes,1,rep,name=agent_pools,json=agentPools,proto3" json:"agent_pools,omitempty"`
	// The list next page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response from ListAgentPools.

func (*ListAgentPoolsResponse) Descriptor deprecated 

func (*ListAgentPoolsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListAgentPoolsResponse.ProtoReflect.Descriptor instead.

func (*ListAgentPoolsResponse) GetAgentPools 

func (x *ListAgentPoolsResponse) GetAgentPools() []*AgentPool

func (*ListAgentPoolsResponse) GetNextPageToken 

func (x *ListAgentPoolsResponse) GetNextPageToken() string

func (*ListAgentPoolsResponse) ProtoMessage 

func (*ListAgentPoolsResponse) ProtoMessage()

func (*ListAgentPoolsResponse) ProtoReflect 

func (x *ListAgentPoolsResponse) ProtoReflect() protoreflect.Message

func (*ListAgentPoolsResponse) Reset 

func (x *ListAgentPoolsResponse) Reset()

func (*ListAgentPoolsResponse) String 

func (x *ListAgentPoolsResponse) String() string

type ListTransferJobsRequest 

type ListTransferJobsRequest struct {

	// Required. A list of query parameters specified as JSON text in the form of:
	// `{"projectId":"my_project_id",
	//
	//	"jobNames":["jobid1","jobid2",...],
	//	"jobStatuses":["status1","status2",...]}`
	//
	// Since `jobNames` and `jobStatuses` support multiple values, their values
	// must be specified with array notation. `projectId` is required.
	// `jobNames` and `jobStatuses` are optional.  The valid values for
	// `jobStatuses` are case-insensitive:
	// [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED],
	// [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], and
	// [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// The list page size. The max allowed value is 256.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The list page token.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

`projectId`, `jobNames`, and `jobStatuses` are query parameters that can be specified when listing transfer jobs.

func (*ListTransferJobsRequest) Descriptor deprecated 

func (*ListTransferJobsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTransferJobsRequest.ProtoReflect.Descriptor instead.

func (*ListTransferJobsRequest) GetFilter 

func (x *ListTransferJobsRequest) GetFilter() string

func (*ListTransferJobsRequest) GetPageSize 

func (x *ListTransferJobsRequest) GetPageSize() int32

func (*ListTransferJobsRequest) GetPageToken 

func (x *ListTransferJobsRequest) GetPageToken() string

func (*ListTransferJobsRequest) ProtoMessage 

func (*ListTransferJobsRequest) ProtoMessage()

func (*ListTransferJobsRequest) ProtoReflect 

func (x *ListTransferJobsRequest) ProtoReflect() protoreflect.Message

func (*ListTransferJobsRequest) Reset 

func (x *ListTransferJobsRequest) Reset()

func (*ListTransferJobsRequest) String 

func (x *ListTransferJobsRequest) String() string

type ListTransferJobsResponse 

type ListTransferJobsResponse struct {

	// A list of transfer jobs.
	TransferJobs []*TransferJob `protobuf:"bytes,1,rep,name=transfer_jobs,json=transferJobs,proto3" json:"transfer_jobs,omitempty"`
	// The list next page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response from ListTransferJobs.

func (*ListTransferJobsResponse) Descriptor deprecated 

func (*ListTransferJobsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTransferJobsResponse.ProtoReflect.Descriptor instead.

func (*ListTransferJobsResponse) GetNextPageToken 

func (x *ListTransferJobsResponse) GetNextPageToken() string

func (*ListTransferJobsResponse) GetTransferJobs 

func (x *ListTransferJobsResponse) GetTransferJobs() []*TransferJob

func (*ListTransferJobsResponse) ProtoMessage 

func (*ListTransferJobsResponse) ProtoMessage()

func (*ListTransferJobsResponse) ProtoReflect 

func (x *ListTransferJobsResponse) ProtoReflect() protoreflect.Message

func (*ListTransferJobsResponse) Reset 

func (x *ListTransferJobsResponse) Reset()

func (*ListTransferJobsResponse) String 

func (x *ListTransferJobsResponse) String() string

type LoggingConfig 

type LoggingConfig struct {

	// Specifies the actions to be logged. If empty, no logs are generated.
	// Not supported for transfers with PosixFilesystem data sources; use
	// [enable_onprem_gcs_transfer_logs][google.storagetransfer.v1.LoggingConfig.enable_onprem_gcs_transfer_logs]
	// instead.
	LogActions []LoggingConfig_LoggableAction `` /* 159-byte string literal not displayed */
	// States in which `log_actions` are logged. If empty, no logs are generated.
	// Not supported for transfers with PosixFilesystem data sources; use
	// [enable_onprem_gcs_transfer_logs][google.storagetransfer.v1.LoggingConfig.enable_onprem_gcs_transfer_logs]
	// instead.
	LogActionStates []LoggingConfig_LoggableActionState `` /* 181-byte string literal not displayed */
	// For transfers with a PosixFilesystem source, this option enables the Cloud
	// Storage transfer logs for this transfer.
	EnableOnpremGcsTransferLogs bool `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies the logging behavior for transfer operations.

For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details.

For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details.

func (*LoggingConfig) Descriptor deprecated 

func (*LoggingConfig) Descriptor() ([]byte, []int)

Deprecated: Use LoggingConfig.ProtoReflect.Descriptor instead.

func (*LoggingConfig) GetEnableOnpremGcsTransferLogs 

func (x *LoggingConfig) GetEnableOnpremGcsTransferLogs() bool

func (*LoggingConfig) GetLogActionStates 

func (x *LoggingConfig) GetLogActionStates() []LoggingConfig_LoggableActionState

func (*LoggingConfig) GetLogActions 

func (x *LoggingConfig) GetLogActions() []LoggingConfig_LoggableAction

func (*LoggingConfig) ProtoMessage 

func (*LoggingConfig) ProtoMessage()

func (*LoggingConfig) ProtoReflect 

func (x *LoggingConfig) ProtoReflect() protoreflect.Message

func (*LoggingConfig) Reset 

func (x *LoggingConfig) Reset()

func (*LoggingConfig) String 

func (x *LoggingConfig) String() string

type LoggingConfig_LoggableAction 

type LoggingConfig_LoggableAction int32

Loggable actions. 

const (
	// Default value. This value is unused.
	LoggingConfig_LOGGABLE_ACTION_UNSPECIFIED LoggingConfig_LoggableAction = 0
	// Listing objects in a bucket.
	LoggingConfig_FIND LoggingConfig_LoggableAction = 1
	// Deleting objects at the source or the destination.
	LoggingConfig_DELETE LoggingConfig_LoggableAction = 2
	// Copying objects to Google Cloud Storage.
	LoggingConfig_COPY LoggingConfig_LoggableAction = 3
)

func (LoggingConfig_LoggableAction) Descriptor 

func (LoggingConfig_LoggableAction) Descriptor() protoreflect.EnumDescriptor

func (LoggingConfig_LoggableAction) Enum 

func (x LoggingConfig_LoggableAction) Enum() *LoggingConfig_LoggableAction

func (LoggingConfig_LoggableAction) EnumDescriptor deprecated 

func (LoggingConfig_LoggableAction) EnumDescriptor() ([]byte, []int)

Deprecated: Use LoggingConfig_LoggableAction.Descriptor instead.

func (LoggingConfig_LoggableAction) Number 

func (x LoggingConfig_LoggableAction) Number() protoreflect.EnumNumber

func (LoggingConfig_LoggableAction) String 

func (x LoggingConfig_LoggableAction) String() string

func (LoggingConfig_LoggableAction) Type 

func (LoggingConfig_LoggableAction) Type() protoreflect.EnumType

type LoggingConfig_LoggableActionState 

type LoggingConfig_LoggableActionState int32

Loggable action states. 

const (
	// Default value. This value is unused.
	LoggingConfig_LOGGABLE_ACTION_STATE_UNSPECIFIED LoggingConfig_LoggableActionState = 0
	// `LoggableAction` completed successfully. `SUCCEEDED` actions are
	// logged as [INFO][google.logging.type.LogSeverity.INFO].
	LoggingConfig_SUCCEEDED LoggingConfig_LoggableActionState = 1
	// `LoggableAction` terminated in an error state. `FAILED` actions are
	// logged as [ERROR][google.logging.type.LogSeverity.ERROR].
	LoggingConfig_FAILED LoggingConfig_LoggableActionState = 2
)

func (LoggingConfig_LoggableActionState) Descriptor 

func (LoggingConfig_LoggableActionState) Descriptor() protoreflect.EnumDescriptor

func (LoggingConfig_LoggableActionState) Enum 

func (x LoggingConfig_LoggableActionState) Enum() *LoggingConfig_LoggableActionState

func (LoggingConfig_LoggableActionState) EnumDescriptor deprecated 

func (LoggingConfig_LoggableActionState) EnumDescriptor() ([]byte, []int)

Deprecated: Use LoggingConfig_LoggableActionState.Descriptor instead.

func (LoggingConfig_LoggableActionState) Number 

func (x LoggingConfig_LoggableActionState) Number() protoreflect.EnumNumber

func (LoggingConfig_LoggableActionState) String 

func (x LoggingConfig_LoggableActionState) String() string

func (LoggingConfig_LoggableActionState) Type 

func (LoggingConfig_LoggableActionState) Type() protoreflect.EnumType

type MetadataOptions 

type MetadataOptions struct {

	// Specifies how symlinks should be handled by the transfer. By default,
	// symlinks are not preserved. Only applicable to transfers involving
	// POSIX file systems, and ignored for other transfers.
	Symlink MetadataOptions_Symlink `protobuf:"varint,1,opt,name=symlink,proto3,enum=google.storagetransfer.v1.MetadataOptions_Symlink" json:"symlink,omitempty"`
	// Specifies how each file's mode attribute should be handled by the transfer.
	// By default, mode is not preserved. Only applicable to transfers involving
	// POSIX file systems, and ignored for other transfers.
	Mode MetadataOptions_Mode `protobuf:"varint,2,opt,name=mode,proto3,enum=google.storagetransfer.v1.MetadataOptions_Mode" json:"mode,omitempty"`
	// Specifies how each file's POSIX group ID (GID) attribute should be handled
	// by the transfer. By default, GID is not preserved. Only applicable to
	// transfers involving POSIX file systems, and ignored for other transfers.
	Gid MetadataOptions_GID `protobuf:"varint,3,opt,name=gid,proto3,enum=google.storagetransfer.v1.MetadataOptions_GID" json:"gid,omitempty"`
	// Specifies how each file's POSIX user ID (UID) attribute should be handled
	// by the transfer. By default, UID is not preserved. Only applicable to
	// transfers involving POSIX file systems, and ignored for other transfers.
	Uid MetadataOptions_UID `protobuf:"varint,4,opt,name=uid,proto3,enum=google.storagetransfer.v1.MetadataOptions_UID" json:"uid,omitempty"`
	// Specifies how each object's ACLs should be preserved for transfers between
	// Google Cloud Storage buckets. If unspecified, the default behavior is the
	// same as ACL_DESTINATION_BUCKET_DEFAULT.
	Acl MetadataOptions_Acl `protobuf:"varint,5,opt,name=acl,proto3,enum=google.storagetransfer.v1.MetadataOptions_Acl" json:"acl,omitempty"`
	// Specifies the storage class to set on objects being transferred to Google
	// Cloud Storage buckets.  If unspecified, the default behavior is the same as
	// [STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT][google.storagetransfer.v1.MetadataOptions.StorageClass.STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT].
	StorageClass MetadataOptions_StorageClass `` /* 158-byte string literal not displayed */
	// Specifies how each object's temporary hold status should be preserved for
	// transfers between Google Cloud Storage buckets.  If unspecified, the
	// default behavior is the same as
	// [TEMPORARY_HOLD_PRESERVE][google.storagetransfer.v1.MetadataOptions.TemporaryHold.TEMPORARY_HOLD_PRESERVE].
	TemporaryHold MetadataOptions_TemporaryHold `` /* 162-byte string literal not displayed */
	// Specifies how each object's Cloud KMS customer-managed encryption key
	// (CMEK) is preserved for transfers between Google Cloud Storage buckets.  If
	// unspecified, the default behavior is the same as
	// [KMS_KEY_DESTINATION_BUCKET_DEFAULT][google.storagetransfer.v1.MetadataOptions.KmsKey.KMS_KEY_DESTINATION_BUCKET_DEFAULT].
	KmsKey MetadataOptions_KmsKey `` /* 134-byte string literal not displayed */
	// Specifies how each object's `timeCreated` metadata is preserved for
	// transfers between Google Cloud Storage buckets.  If unspecified, the
	// default behavior is the same as
	// [TIME_CREATED_SKIP][google.storagetransfer.v1.MetadataOptions.TimeCreated.TIME_CREATED_SKIP].
	TimeCreated MetadataOptions_TimeCreated `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specifies the metadata options for running a transfer.

func (*MetadataOptions) Descriptor deprecated 

func (*MetadataOptions) Descriptor() ([]byte, []int)

Deprecated: Use MetadataOptions.ProtoReflect.Descriptor instead.

func (*MetadataOptions) GetAcl 

func (x *MetadataOptions) GetAcl() MetadataOptions_Acl

func (*MetadataOptions) GetGid 

func (x *MetadataOptions) GetGid() MetadataOptions_GID

func (*MetadataOptions) GetKmsKey 

func (x *MetadataOptions) GetKmsKey() MetadataOptions_KmsKey

func (*MetadataOptions) GetMode 

func (x *MetadataOptions) GetMode() MetadataOptions_Mode

func (*MetadataOptions) GetStorageClass 

func (x *MetadataOptions) GetStorageClass() MetadataOptions_StorageClass
func (x *MetadataOptions) GetSymlink() MetadataOptions_Symlink

func (*MetadataOptions) GetTemporaryHold 

func (x *MetadataOptions) GetTemporaryHold() MetadataOptions_TemporaryHold

func (*MetadataOptions) GetTimeCreated 

func (x *MetadataOptions) GetTimeCreated() MetadataOptions_TimeCreated

func (*MetadataOptions) GetUid 

func (x *MetadataOptions) GetUid() MetadataOptions_UID

func (*MetadataOptions) ProtoMessage 

func (*MetadataOptions) ProtoMessage()

func (*MetadataOptions) ProtoReflect 

func (x *MetadataOptions) ProtoReflect() protoreflect.Message

func (*MetadataOptions) Reset 

func (x *MetadataOptions) Reset()

func (*MetadataOptions) String 

func (x *MetadataOptions) String() string

type MetadataOptions_Acl 

type MetadataOptions_Acl int32

Options for handling Cloud Storage object ACLs. 

const (
	// ACL behavior is unspecified.
	MetadataOptions_ACL_UNSPECIFIED MetadataOptions_Acl = 0
	// Use the destination bucket's default object ACLS, if applicable.
	MetadataOptions_ACL_DESTINATION_BUCKET_DEFAULT MetadataOptions_Acl = 1
	// Preserve the object's original ACLs. This requires the service account
	// to have `storage.objects.getIamPolicy` permission for the source object.
	// [Uniform bucket-level
	// access](https://cloud.google.com/storage/docs/uniform-bucket-level-access)
	// must not be enabled on either the source or destination buckets.
	MetadataOptions_ACL_PRESERVE MetadataOptions_Acl = 2
)

func (MetadataOptions_Acl) Descriptor 

func (MetadataOptions_Acl) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_Acl) Enum 

func (x MetadataOptions_Acl) Enum() *MetadataOptions_Acl

func (MetadataOptions_Acl) EnumDescriptor deprecated 

func (MetadataOptions_Acl) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_Acl.Descriptor instead.

func (MetadataOptions_Acl) Number 

func (x MetadataOptions_Acl) Number() protoreflect.EnumNumber

func (MetadataOptions_Acl) String 

func (x MetadataOptions_Acl) String() string

func (MetadataOptions_Acl) Type 

func (MetadataOptions_Acl) Type() protoreflect.EnumType

type MetadataOptions_GID 

type MetadataOptions_GID int32

Options for handling file GID attribute. 

const (
	// GID behavior is unspecified.
	MetadataOptions_GID_UNSPECIFIED MetadataOptions_GID = 0
	// Do not preserve GID during a transfer job.
	MetadataOptions_GID_SKIP MetadataOptions_GID = 1
	// Preserve GID during a transfer job.
	MetadataOptions_GID_NUMBER MetadataOptions_GID = 2
)

func (MetadataOptions_GID) Descriptor 

func (MetadataOptions_GID) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_GID) Enum 

func (x MetadataOptions_GID) Enum() *MetadataOptions_GID

func (MetadataOptions_GID) EnumDescriptor deprecated 

func (MetadataOptions_GID) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_GID.Descriptor instead.

func (MetadataOptions_GID) Number 

func (x MetadataOptions_GID) Number() protoreflect.EnumNumber

func (MetadataOptions_GID) String 

func (x MetadataOptions_GID) String() string

func (MetadataOptions_GID) Type 

func (MetadataOptions_GID) Type() protoreflect.EnumType

type MetadataOptions_KmsKey 

type MetadataOptions_KmsKey int32

Options for handling the KmsKey setting for Google Cloud Storage objects. 

const (
	// KmsKey behavior is unspecified.
	MetadataOptions_KMS_KEY_UNSPECIFIED MetadataOptions_KmsKey = 0
	// Use the destination bucket's default encryption settings.
	MetadataOptions_KMS_KEY_DESTINATION_BUCKET_DEFAULT MetadataOptions_KmsKey = 1
	// Preserve the object's original Cloud KMS customer-managed encryption key
	// (CMEK) if present. Objects that do not use a Cloud KMS encryption key
	// will be encrypted using the destination bucket's encryption settings.
	MetadataOptions_KMS_KEY_PRESERVE MetadataOptions_KmsKey = 2
)

func (MetadataOptions_KmsKey) Descriptor 

func (MetadataOptions_KmsKey) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_KmsKey) Enum 

func (x MetadataOptions_KmsKey) Enum() *MetadataOptions_KmsKey

func (MetadataOptions_KmsKey) EnumDescriptor deprecated 

func (MetadataOptions_KmsKey) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_KmsKey.Descriptor instead.

func (MetadataOptions_KmsKey) Number 

func (x MetadataOptions_KmsKey) Number() protoreflect.EnumNumber

func (MetadataOptions_KmsKey) String 

func (x MetadataOptions_KmsKey) String() string

func (MetadataOptions_KmsKey) Type 

func (MetadataOptions_KmsKey) Type() protoreflect.EnumType

type MetadataOptions_Mode 

type MetadataOptions_Mode int32

Options for handling file mode attribute. 

const (
	// Mode behavior is unspecified.
	MetadataOptions_MODE_UNSPECIFIED MetadataOptions_Mode = 0
	// Do not preserve mode during a transfer job.
	MetadataOptions_MODE_SKIP MetadataOptions_Mode = 1
	// Preserve mode during a transfer job.
	MetadataOptions_MODE_PRESERVE MetadataOptions_Mode = 2
)

func (MetadataOptions_Mode) Descriptor 

func (MetadataOptions_Mode) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_Mode) Enum 

func (x MetadataOptions_Mode) Enum() *MetadataOptions_Mode

func (MetadataOptions_Mode) EnumDescriptor deprecated 

func (MetadataOptions_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_Mode.Descriptor instead.

func (MetadataOptions_Mode) Number 

func (x MetadataOptions_Mode) Number() protoreflect.EnumNumber

func (MetadataOptions_Mode) String 

func (x MetadataOptions_Mode) String() string

func (MetadataOptions_Mode) Type 

func (MetadataOptions_Mode) Type() protoreflect.EnumType

type MetadataOptions_StorageClass 

type MetadataOptions_StorageClass int32

Options for handling Google Cloud Storage object storage class. 

const (
	// Storage class behavior is unspecified.
	MetadataOptions_STORAGE_CLASS_UNSPECIFIED MetadataOptions_StorageClass = 0
	// Use the destination bucket's default storage class.
	MetadataOptions_STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT MetadataOptions_StorageClass = 1
	// Preserve the object's original storage class. This is only supported for
	// transfers from Google Cloud Storage buckets. REGIONAL and MULTI_REGIONAL
	// storage classes will be mapped to STANDARD to ensure they can be written
	// to the destination bucket.
	MetadataOptions_STORAGE_CLASS_PRESERVE MetadataOptions_StorageClass = 2
	// Set the storage class to STANDARD.
	MetadataOptions_STORAGE_CLASS_STANDARD MetadataOptions_StorageClass = 3
	// Set the storage class to NEARLINE.
	MetadataOptions_STORAGE_CLASS_NEARLINE MetadataOptions_StorageClass = 4
	// Set the storage class to COLDLINE.
	MetadataOptions_STORAGE_CLASS_COLDLINE MetadataOptions_StorageClass = 5
	// Set the storage class to ARCHIVE.
	MetadataOptions_STORAGE_CLASS_ARCHIVE MetadataOptions_StorageClass = 6
)

func (MetadataOptions_StorageClass) Descriptor 

func (MetadataOptions_StorageClass) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_StorageClass) Enum 

func (x MetadataOptions_StorageClass) Enum() *MetadataOptions_StorageClass

func (MetadataOptions_StorageClass) EnumDescriptor deprecated 

func (MetadataOptions_StorageClass) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_StorageClass.Descriptor instead.

func (MetadataOptions_StorageClass) Number 

func (x MetadataOptions_StorageClass) Number() protoreflect.EnumNumber

func (MetadataOptions_StorageClass) String 

func (x MetadataOptions_StorageClass) String() string

func (MetadataOptions_StorageClass) Type 

func (MetadataOptions_StorageClass) Type() protoreflect.EnumType
type MetadataOptions_Symlink int32

Whether symlinks should be skipped or preserved during a transfer job. 

const (
	// Symlink behavior is unspecified.
	MetadataOptions_SYMLINK_UNSPECIFIED MetadataOptions_Symlink = 0
	// Do not preserve symlinks during a transfer job.
	MetadataOptions_SYMLINK_SKIP MetadataOptions_Symlink = 1
	// Preserve symlinks during a transfer job.
	MetadataOptions_SYMLINK_PRESERVE MetadataOptions_Symlink = 2
)

func (MetadataOptions_Symlink) Descriptor 

func (MetadataOptions_Symlink) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_Symlink) Enum 

func (x MetadataOptions_Symlink) Enum() *MetadataOptions_Symlink

func (MetadataOptions_Symlink) EnumDescriptor deprecated 

func (MetadataOptions_Symlink) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_Symlink.Descriptor instead.

func (MetadataOptions_Symlink) Number 

func (x MetadataOptions_Symlink) Number() protoreflect.EnumNumber

func (MetadataOptions_Symlink) String 

func (x MetadataOptions_Symlink) String() string

func (MetadataOptions_Symlink) Type 

func (MetadataOptions_Symlink) Type() protoreflect.EnumType

type MetadataOptions_TemporaryHold 

type MetadataOptions_TemporaryHold int32

Options for handling temporary holds for Google Cloud Storage objects. 

const (
	// Temporary hold behavior is unspecified.
	MetadataOptions_TEMPORARY_HOLD_UNSPECIFIED MetadataOptions_TemporaryHold = 0
	// Do not set a temporary hold on the destination object.
	MetadataOptions_TEMPORARY_HOLD_SKIP MetadataOptions_TemporaryHold = 1
	// Preserve the object's original temporary hold status.
	MetadataOptions_TEMPORARY_HOLD_PRESERVE MetadataOptions_TemporaryHold = 2
)

func (MetadataOptions_TemporaryHold) Descriptor 

func (MetadataOptions_TemporaryHold) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_TemporaryHold) Enum 

func (x MetadataOptions_TemporaryHold) Enum() *MetadataOptions_TemporaryHold

func (MetadataOptions_TemporaryHold) EnumDescriptor deprecated 

func (MetadataOptions_TemporaryHold) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_TemporaryHold.Descriptor instead.

func (MetadataOptions_TemporaryHold) Number 

func (x MetadataOptions_TemporaryHold) Number() protoreflect.EnumNumber

func (MetadataOptions_TemporaryHold) String 

func (x MetadataOptions_TemporaryHold) String() string

func (MetadataOptions_TemporaryHold) Type 

func (MetadataOptions_TemporaryHold) Type() protoreflect.EnumType

type MetadataOptions_TimeCreated 

type MetadataOptions_TimeCreated int32

Options for handling `timeCreated` metadata for Google Cloud Storage objects. 

const (
	// TimeCreated behavior is unspecified.
	MetadataOptions_TIME_CREATED_UNSPECIFIED MetadataOptions_TimeCreated = 0
	// Do not preserve the `timeCreated` metadata from the source object.
	MetadataOptions_TIME_CREATED_SKIP MetadataOptions_TimeCreated = 1
	// Preserves the source object's `timeCreated` metadata in the `customTime`
	// field in the destination object.  Note that any value stored in the
	// source object's `customTime` field will not be propagated to the
	// destination object.
	MetadataOptions_TIME_CREATED_PRESERVE_AS_CUSTOM_TIME MetadataOptions_TimeCreated = 2
)

func (MetadataOptions_TimeCreated) Descriptor 

func (MetadataOptions_TimeCreated) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_TimeCreated) Enum 

func (x MetadataOptions_TimeCreated) Enum() *MetadataOptions_TimeCreated

func (MetadataOptions_TimeCreated) EnumDescriptor deprecated 

func (MetadataOptions_TimeCreated) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_TimeCreated.Descriptor instead.

func (MetadataOptions_TimeCreated) Number 

func (x MetadataOptions_TimeCreated) Number() protoreflect.EnumNumber

func (MetadataOptions_TimeCreated) String 

func (x MetadataOptions_TimeCreated) String() string

func (MetadataOptions_TimeCreated) Type 

func (MetadataOptions_TimeCreated) Type() protoreflect.EnumType

type MetadataOptions_UID 

type MetadataOptions_UID int32

Options for handling file UID attribute. 

const (
	// UID behavior is unspecified.
	MetadataOptions_UID_UNSPECIFIED MetadataOptions_UID = 0
	// Do not preserve UID during a transfer job.
	MetadataOptions_UID_SKIP MetadataOptions_UID = 1
	// Preserve UID during a transfer job.
	MetadataOptions_UID_NUMBER MetadataOptions_UID = 2
)

func (MetadataOptions_UID) Descriptor 

func (MetadataOptions_UID) Descriptor() protoreflect.EnumDescriptor

func (MetadataOptions_UID) Enum 

func (x MetadataOptions_UID) Enum() *MetadataOptions_UID

func (MetadataOptions_UID) EnumDescriptor deprecated 

func (MetadataOptions_UID) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_UID.Descriptor instead.

func (MetadataOptions_UID) Number 

func (x MetadataOptions_UID) Number() protoreflect.EnumNumber

func (MetadataOptions_UID) String 

func (x MetadataOptions_UID) String() string

func (MetadataOptions_UID) Type 

func (MetadataOptions_UID) Type() protoreflect.EnumType

type NotificationConfig 

type NotificationConfig struct {

	// Required. The `Topic.name` of the Pub/Sub topic to which to publish
	// notifications. Must be of the format: `projects/{project}/topics/{topic}`.
	// Not matching this format results in an
	// [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] error.
	PubsubTopic string `protobuf:"bytes,1,opt,name=pubsub_topic,json=pubsubTopic,proto3" json:"pubsub_topic,omitempty"`
	// Event types for which a notification is desired. If empty, send
	// notifications for all event types.
	EventTypes []NotificationConfig_EventType `` /* 159-byte string literal not displayed */
	// Required. The desired format of the notification message payloads.
	PayloadFormat NotificationConfig_PayloadFormat `` /* 165-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`:

* `"eventType"`: one of the [EventType][google.storagetransfer.v1.NotificationConfig.EventType] values * `"payloadFormat"`: one of the [PayloadFormat][google.storagetransfer.v1.NotificationConfig.PayloadFormat] values * `"projectId"`: the [project_id][google.storagetransfer.v1.TransferOperation.project_id] of the `TransferOperation` * `"transferJobName"`: the [transfer_job_name][google.storagetransfer.v1.TransferOperation.transfer_job_name] of the `TransferOperation` * `"transferOperationName"`: the [name][google.storagetransfer.v1.TransferOperation.name] of the `TransferOperation`

The `PubsubMessage.data` contains a TransferOperation[google.storagetransfer.v1.TransferOperation] resource formatted according to the specified `PayloadFormat`.

func (*NotificationConfig) Descriptor deprecated 

func (*NotificationConfig) Descriptor() ([]byte, []int)

Deprecated: Use NotificationConfig.ProtoReflect.Descriptor instead.

func (*NotificationConfig) GetEventTypes 

func (x *NotificationConfig) GetEventTypes() []NotificationConfig_EventType

func (*NotificationConfig) GetPayloadFormat 

func (x *NotificationConfig) GetPayloadFormat() NotificationConfig_PayloadFormat

func (*NotificationConfig) GetPubsubTopic 

func (x *NotificationConfig) GetPubsubTopic() string

func (*NotificationConfig) ProtoMessage 

func (*NotificationConfig) ProtoMessage()

func (*NotificationConfig) ProtoReflect 

func (x *NotificationConfig) ProtoReflect() protoreflect.Message

func (*NotificationConfig) Reset 

func (x *NotificationConfig) Reset()

func (*NotificationConfig) String 

func (x *NotificationConfig) String() string

type NotificationConfig_EventType 

type NotificationConfig_EventType int32

Enum for specifying event types for which notifications are to be published.

Additional event types may be added in the future. Clients should either safely ignore unrecognized event types or explicitly specify which event types they are prepared to accept. 

const (
	// Illegal value, to avoid allowing a default.
	NotificationConfig_EVENT_TYPE_UNSPECIFIED NotificationConfig_EventType = 0
	// `TransferOperation` completed with status
	// [SUCCESS][google.storagetransfer.v1.TransferOperation.Status.SUCCESS].
	NotificationConfig_TRANSFER_OPERATION_SUCCESS NotificationConfig_EventType = 1
	// `TransferOperation` completed with status
	// [FAILED][google.storagetransfer.v1.TransferOperation.Status.FAILED].
	NotificationConfig_TRANSFER_OPERATION_FAILED NotificationConfig_EventType = 2
	// `TransferOperation` completed with status
	// [ABORTED][google.storagetransfer.v1.TransferOperation.Status.ABORTED].
	NotificationConfig_TRANSFER_OPERATION_ABORTED NotificationConfig_EventType = 3
)

func (NotificationConfig_EventType) Descriptor 

func (NotificationConfig_EventType) Descriptor() protoreflect.EnumDescriptor

func (NotificationConfig_EventType) Enum 

func (x NotificationConfig_EventType) Enum() *NotificationConfig_EventType

func (NotificationConfig_EventType) EnumDescriptor deprecated 

func (NotificationConfig_EventType) EnumDescriptor() ([]byte, []int)

Deprecated: Use NotificationConfig_EventType.Descriptor instead.

func (NotificationConfig_EventType) Number 

func (x NotificationConfig_EventType) Number() protoreflect.EnumNumber

func (NotificationConfig_EventType) String 

func (x NotificationConfig_EventType) String() string

func (NotificationConfig_EventType) Type 

func (NotificationConfig_EventType) Type() protoreflect.EnumType

type NotificationConfig_PayloadFormat 

type NotificationConfig_PayloadFormat int32

Enum for specifying the format of a notification message's payload. 

const (
	// Illegal value, to avoid allowing a default.
	NotificationConfig_PAYLOAD_FORMAT_UNSPECIFIED NotificationConfig_PayloadFormat = 0
	// No payload is included with the notification.
	NotificationConfig_NONE NotificationConfig_PayloadFormat = 1
	// `TransferOperation` is [formatted as a JSON
	// response](https://developers.google.com/protocol-buffers/docs/proto3#json),
	// in application/json.
	NotificationConfig_JSON NotificationConfig_PayloadFormat = 2
)

func (NotificationConfig_PayloadFormat) Descriptor 

func (NotificationConfig_PayloadFormat) Descriptor() protoreflect.EnumDescriptor

func (NotificationConfig_PayloadFormat) Enum 

func (x NotificationConfig_PayloadFormat) Enum() *NotificationConfig_PayloadFormat

func (NotificationConfig_PayloadFormat) EnumDescriptor deprecated 

func (NotificationConfig_PayloadFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use NotificationConfig_PayloadFormat.Descriptor instead.

func (NotificationConfig_PayloadFormat) Number 

func (x NotificationConfig_PayloadFormat) Number() protoreflect.EnumNumber

func (NotificationConfig_PayloadFormat) String 

func (x NotificationConfig_PayloadFormat) String() string

func (NotificationConfig_PayloadFormat) Type 

func (NotificationConfig_PayloadFormat) Type() protoreflect.EnumType

type ObjectConditions 

type ObjectConditions struct {

	// Ensures that objects are not transferred until a specific minimum time
	// has elapsed after the "last modification time". When a
	// [TransferOperation][google.storagetransfer.v1.TransferOperation] begins,
	// objects with a "last modification time" are transferred only if the elapsed
	// time between the
	// [start_time][google.storagetransfer.v1.TransferOperation.start_time] of the
	// `TransferOperation` and the "last modification time" of the object is equal
	// to or greater than the value of min_time_elapsed_since_last_modification`.
	// Objects that do not have a "last modification time" are also transferred.
	MinTimeElapsedSinceLastModification *durationpb.Duration `` /* 174-byte string literal not displayed */
	// Ensures that objects are not transferred if a specific maximum time
	// has elapsed since the "last modification time".
	// When a [TransferOperation][google.storagetransfer.v1.TransferOperation]
	// begins, objects with a "last modification time" are transferred only if the
	// elapsed time between the
	// [start_time][google.storagetransfer.v1.TransferOperation.start_time] of the
	// `TransferOperation`and the "last modification time" of the object
	//
	//	is less than the value of max_time_elapsed_since_last_modification`.
	//
	// Objects that do not have a "last modification time" are also transferred.
	MaxTimeElapsedSinceLastModification *durationpb.Duration `` /* 174-byte string literal not displayed */
	// If you specify `include_prefixes`, Storage Transfer Service uses the items
	// in the `include_prefixes` array to determine which objects to include in a
	// transfer. Objects must start with one of the matching `include_prefixes`
	// for inclusion in the transfer. If
	// [exclude_prefixes][google.storagetransfer.v1.ObjectConditions.exclude_prefixes]
	// is specified, objects must not start with any of the `exclude_prefixes`
	// specified for inclusion in the transfer.
	//
	// The following are requirements of `include_prefixes`:
	//
	//   - Each include-prefix can contain any sequence of Unicode characters, to
	//     a max length of 1024 bytes when UTF8-encoded, and must not contain
	//     Carriage Return or Line Feed characters.  Wildcard matching and regular
	//     expression matching are not supported.
	//
	//   - Each include-prefix must omit the leading slash. For example, to
	//     include the object `s3://my-aws-bucket/logs/y=2015/requests.gz`,
	//     specify the include-prefix as `logs/y=2015/requests.gz`.
	//
	//   - None of the include-prefix values can be empty, if specified.
	//
	//   - Each include-prefix must include a distinct portion of the object
	//     namespace. No include-prefix may be a prefix of another
	//     include-prefix.
	//
	// The max size of `include_prefixes` is 1000.
	//
	// For more information, see [Filtering objects from
	// transfers](/storage-transfer/docs/filtering-objects-from-transfers).
	IncludePrefixes []string `protobuf:"bytes,3,rep,name=include_prefixes,json=includePrefixes,proto3" json:"include_prefixes,omitempty"`
	// If you specify `exclude_prefixes`, Storage Transfer Service uses the items
	// in the `exclude_prefixes` array to determine which objects to exclude from
	// a transfer. Objects must not start with one of the matching
	// `exclude_prefixes` for inclusion in a transfer.
	//
	// The following are requirements of `exclude_prefixes`:
	//
	//   - Each exclude-prefix can contain any sequence of Unicode characters, to
	//     a max length of 1024 bytes when UTF8-encoded, and must not contain
	//     Carriage Return or Line Feed characters.  Wildcard matching and regular
	//     expression matching are not supported.
	//
	//   - Each exclude-prefix must omit the leading slash. For example, to
	//     exclude the object `s3://my-aws-bucket/logs/y=2015/requests.gz`,
	//     specify the exclude-prefix as `logs/y=2015/requests.gz`.
	//
	//   - None of the exclude-prefix values can be empty, if specified.
	//
	//   - Each exclude-prefix must exclude a distinct portion of the object
	//     namespace. No exclude-prefix may be a prefix of another
	//     exclude-prefix.
	//
	//   - If
	//     [include_prefixes][google.storagetransfer.v1.ObjectConditions.include_prefixes]
	//     is specified, then each exclude-prefix must start with the value of a
	//     path explicitly included by `include_prefixes`.
	//
	// The max size of `exclude_prefixes` is 1000.
	//
	// For more information, see [Filtering objects from
	// transfers](/storage-transfer/docs/filtering-objects-from-transfers).
	ExcludePrefixes []string `protobuf:"bytes,4,rep,name=exclude_prefixes,json=excludePrefixes,proto3" json:"exclude_prefixes,omitempty"`
	// If specified, only objects with a "last modification time" on or after
	// this timestamp and objects that don't have a "last modification time" are
	// transferred.
	//
	// The `last_modified_since` and `last_modified_before` fields can be used
	// together for chunked data processing. For example, consider a script that
	// processes each day's worth of data at a time. For that you'd set each
	// of the fields as follows:
	//
	// *  `last_modified_since` to the start of the day
	//
	// *  `last_modified_before` to the end of the day
	LastModifiedSince *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=last_modified_since,json=lastModifiedSince,proto3" json:"last_modified_since,omitempty"`
	// If specified, only objects with a "last modification time" before this
	// timestamp and objects that don't have a "last modification time" are
	// transferred.
	LastModifiedBefore *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=last_modified_before,json=lastModifiedBefore,proto3" json:"last_modified_before,omitempty"`
	// contains filtered or unexported fields
}

Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage.

The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the `Last-Modified` header of Azure blobs.

Transfers with a PosixFilesystem[google.storagetransfer.v1.PosixFilesystem] source or destination don't support `ObjectConditions`.

func (*ObjectConditions) Descriptor deprecated 

func (*ObjectConditions) Descriptor() ([]byte, []int)

Deprecated: Use ObjectConditions.ProtoReflect.Descriptor instead.

func (*ObjectConditions) GetExcludePrefixes 

func (x *ObjectConditions) GetExcludePrefixes() []string

func (*ObjectConditions) GetIncludePrefixes 

func (x *ObjectConditions) GetIncludePrefixes() []string

func (*ObjectConditions) GetLastModifiedBefore 

func (x *ObjectConditions) GetLastModifiedBefore() *timestamppb.Timestamp

func (*ObjectConditions) GetLastModifiedSince 

func (x *ObjectConditions) GetLastModifiedSince() *timestamppb.Timestamp

func (*ObjectConditions) GetMaxTimeElapsedSinceLastModification 

func (x *ObjectConditions) GetMaxTimeElapsedSinceLastModification() *durationpb.Duration

func (*ObjectConditions) GetMinTimeElapsedSinceLastModification 

func (x *ObjectConditions) GetMinTimeElapsedSinceLastModification() *durationpb.Duration

func (*ObjectConditions) ProtoMessage 

func (*ObjectConditions) ProtoMessage()

func (*ObjectConditions) ProtoReflect 

func (x *ObjectConditions) ProtoReflect() protoreflect.Message

func (*ObjectConditions) Reset 

func (x *ObjectConditions) Reset()

func (*ObjectConditions) String 

func (x *ObjectConditions) String() string

type PauseTransferOperationRequest 

type PauseTransferOperationRequest struct {

	// Required. The name of the transfer operation.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request passed to PauseTransferOperation.

func (*PauseTransferOperationRequest) Descriptor deprecated 

func (*PauseTransferOperationRequest) Descriptor() ([]byte, []int)

Deprecated: Use PauseTransferOperationRequest.ProtoReflect.Descriptor instead.

func (*PauseTransferOperationRequest) GetName 

func (x *PauseTransferOperationRequest) GetName() string

func (*PauseTransferOperationRequest) ProtoMessage 

func (*PauseTransferOperationRequest) ProtoMessage()

func (*PauseTransferOperationRequest) ProtoReflect 

func (x *PauseTransferOperationRequest) ProtoReflect() protoreflect.Message

func (*PauseTransferOperationRequest) Reset 

func (x *PauseTransferOperationRequest) Reset()

func (*PauseTransferOperationRequest) String 

func (x *PauseTransferOperationRequest) String() string

type PosixFilesystem 

type PosixFilesystem struct {

	// Root directory path to the filesystem.
	RootDirectory string `protobuf:"bytes,1,opt,name=root_directory,json=rootDirectory,proto3" json:"root_directory,omitempty"`
	// contains filtered or unexported fields
}

A POSIX filesystem resource.

func (*PosixFilesystem) Descriptor deprecated 

func (*PosixFilesystem) Descriptor() ([]byte, []int)

Deprecated: Use PosixFilesystem.ProtoReflect.Descriptor instead.

func (*PosixFilesystem) GetRootDirectory 

func (x *PosixFilesystem) GetRootDirectory() string

func (*PosixFilesystem) ProtoMessage 

func (*PosixFilesystem) ProtoMessage()

func (*PosixFilesystem) ProtoReflect 

func (x *PosixFilesystem) ProtoReflect() protoreflect.Message

func (*PosixFilesystem) Reset 

func (x *PosixFilesystem) Reset()

func (*PosixFilesystem) String 

func (x *PosixFilesystem) String() string

type ResumeTransferOperationRequest 

type ResumeTransferOperationRequest struct {

	// Required. The name of the transfer operation.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request passed to ResumeTransferOperation.

func (*ResumeTransferOperationRequest) Descriptor deprecated 

func (*ResumeTransferOperationRequest) Descriptor() ([]byte, []int)

Deprecated: Use ResumeTransferOperationRequest.ProtoReflect.Descriptor instead.

func (*ResumeTransferOperationRequest) GetName 

func (x *ResumeTransferOperationRequest) GetName() string

func (*ResumeTransferOperationRequest) ProtoMessage 

func (*ResumeTransferOperationRequest) ProtoMessage()

func (*ResumeTransferOperationRequest) ProtoReflect 

func (x *ResumeTransferOperationRequest) ProtoReflect() protoreflect.Message

func (*ResumeTransferOperationRequest) Reset 

func (x *ResumeTransferOperationRequest) Reset()

func (*ResumeTransferOperationRequest) String 

func (x *ResumeTransferOperationRequest) String() string

type RunTransferJobRequest 

type RunTransferJobRequest struct {

	// Required. The name of the transfer job.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// Required. The ID of the Google Cloud project that owns the transfer
	// job.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// contains filtered or unexported fields
}

Request passed to RunTransferJob.

func (*RunTransferJobRequest) Descriptor deprecated 

func (*RunTransferJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use RunTransferJobRequest.ProtoReflect.Descriptor instead.

func (*RunTransferJobRequest) GetJobName 

func (x *RunTransferJobRequest) GetJobName() string

func (*RunTransferJobRequest) GetProjectId 

func (x *RunTransferJobRequest) GetProjectId() string

func (*RunTransferJobRequest) ProtoMessage 

func (*RunTransferJobRequest) ProtoMessage()

func (*RunTransferJobRequest) ProtoReflect 

func (x *RunTransferJobRequest) ProtoReflect() protoreflect.Message

func (*RunTransferJobRequest) Reset 

func (x *RunTransferJobRequest) Reset()

func (*RunTransferJobRequest) String 

func (x *RunTransferJobRequest) String() string

type S3CompatibleMetadata 

type S3CompatibleMetadata struct {

	// Specifies the authentication and authorization method used by the storage
	// service. When not specified, Transfer Service will attempt to determine
	// right auth method to use.
	AuthMethod S3CompatibleMetadata_AuthMethod `` /* 155-byte string literal not displayed */
	// Specifies the API request model used to call the storage service. When not
	// specified, the default value of RequestModel
	// REQUEST_MODEL_VIRTUAL_HOSTED_STYLE is used.
	RequestModel S3CompatibleMetadata_RequestModel `` /* 163-byte string literal not displayed */
	// Specifies the network protocol of the agent. When not specified, the
	// default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
	Protocol S3CompatibleMetadata_NetworkProtocol `` /* 138-byte string literal not displayed */
	// The Listing API to use for discovering objects. When not specified,
	// Transfer Service will attempt to determine the right API to use.
	ListApi S3CompatibleMetadata_ListApi `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.

func (*S3CompatibleMetadata) Descriptor deprecated 

func (*S3CompatibleMetadata) Descriptor() ([]byte, []int)

Deprecated: Use S3CompatibleMetadata.ProtoReflect.Descriptor instead.

func (*S3CompatibleMetadata) GetAuthMethod 

func (x *S3CompatibleMetadata) GetAuthMethod() S3CompatibleMetadata_AuthMethod

func (*S3CompatibleMetadata) GetListApi 

func (x *S3CompatibleMetadata) GetListApi() S3CompatibleMetadata_ListApi

func (*S3CompatibleMetadata) GetProtocol 

func (x *S3CompatibleMetadata) GetProtocol() S3CompatibleMetadata_NetworkProtocol

func (*S3CompatibleMetadata) GetRequestModel 

func (x *S3CompatibleMetadata) GetRequestModel() S3CompatibleMetadata_RequestModel

func (*S3CompatibleMetadata) ProtoMessage 

func (*S3CompatibleMetadata) ProtoMessage()

func (*S3CompatibleMetadata) ProtoReflect 

func (x *S3CompatibleMetadata) ProtoReflect() protoreflect.Message

func (*S3CompatibleMetadata) Reset 

func (x *S3CompatibleMetadata) Reset()

func (*S3CompatibleMetadata) String 

func (x *S3CompatibleMetadata) String() string

type S3CompatibleMetadata_AuthMethod 

type S3CompatibleMetadata_AuthMethod int32

The authentication and authorization method used by the storage service. 

const (
	// AuthMethod is not specified.
	S3CompatibleMetadata_AUTH_METHOD_UNSPECIFIED S3CompatibleMetadata_AuthMethod = 0
	// Auth requests with AWS SigV4.
	S3CompatibleMetadata_AUTH_METHOD_AWS_SIGNATURE_V4 S3CompatibleMetadata_AuthMethod = 1
	// Auth requests with AWS SigV2.
	S3CompatibleMetadata_AUTH_METHOD_AWS_SIGNATURE_V2 S3CompatibleMetadata_AuthMethod = 2
)

func (S3CompatibleMetadata_AuthMethod) Descriptor 

func (S3CompatibleMetadata_AuthMethod) Descriptor() protoreflect.EnumDescriptor

func (S3CompatibleMetadata_AuthMethod) Enum 

func (x S3CompatibleMetadata_AuthMethod) Enum() *S3CompatibleMetadata_AuthMethod

func (S3CompatibleMetadata_AuthMethod) EnumDescriptor deprecated 

func (S3CompatibleMetadata_AuthMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use S3CompatibleMetadata_AuthMethod.Descriptor instead.

func (S3CompatibleMetadata_AuthMethod) Number 

func (x S3CompatibleMetadata_AuthMethod) Number() protoreflect.EnumNumber

func (S3CompatibleMetadata_AuthMethod) String 

func (x S3CompatibleMetadata_AuthMethod) String() string

func (S3CompatibleMetadata_AuthMethod) Type 

func (S3CompatibleMetadata_AuthMethod) Type() protoreflect.EnumType

type S3CompatibleMetadata_ListApi 

type S3CompatibleMetadata_ListApi int32

The Listing API to use for discovering objects. 

const (
	// ListApi is not specified.
	S3CompatibleMetadata_LIST_API_UNSPECIFIED S3CompatibleMetadata_ListApi = 0
	// Perform listing using ListObjectsV2 API.
	S3CompatibleMetadata_LIST_OBJECTS_V2 S3CompatibleMetadata_ListApi = 1
	// Legacy ListObjects API.
	S3CompatibleMetadata_LIST_OBJECTS S3CompatibleMetadata_ListApi = 2
)

func (S3CompatibleMetadata_ListApi) Descriptor 

func (S3CompatibleMetadata_ListApi) Descriptor() protoreflect.EnumDescriptor

func (S3CompatibleMetadata_ListApi) Enum 

func (x S3CompatibleMetadata_ListApi) Enum() *S3CompatibleMetadata_ListApi

func (S3CompatibleMetadata_ListApi) EnumDescriptor deprecated 

func (S3CompatibleMetadata_ListApi) EnumDescriptor() ([]byte, []int)

Deprecated: Use S3CompatibleMetadata_ListApi.Descriptor instead.

func (S3CompatibleMetadata_ListApi) Number 

func (x S3CompatibleMetadata_ListApi) Number() protoreflect.EnumNumber

func (S3CompatibleMetadata_ListApi) String 

func (x S3CompatibleMetadata_ListApi) String() string

func (S3CompatibleMetadata_ListApi) Type 

func (S3CompatibleMetadata_ListApi) Type() protoreflect.EnumType

type S3CompatibleMetadata_NetworkProtocol 

type S3CompatibleMetadata_NetworkProtocol int32

The agent network protocol to access the storage service. 

const (
	// NetworkProtocol is not specified.
	S3CompatibleMetadata_NETWORK_PROTOCOL_UNSPECIFIED S3CompatibleMetadata_NetworkProtocol = 0
	// Perform requests using HTTPS.
	S3CompatibleMetadata_NETWORK_PROTOCOL_HTTPS S3CompatibleMetadata_NetworkProtocol = 1
	// Not recommended: This sends data in clear-text. This is only
	// appropriate within a closed network or for publicly available data.
	// Perform requests using HTTP.
	S3CompatibleMetadata_NETWORK_PROTOCOL_HTTP S3CompatibleMetadata_NetworkProtocol = 2
)

func (S3CompatibleMetadata_NetworkProtocol) Descriptor 

func (S3CompatibleMetadata_NetworkProtocol) Descriptor() protoreflect.EnumDescriptor

func (S3CompatibleMetadata_NetworkProtocol) Enum 

func (x S3CompatibleMetadata_NetworkProtocol) Enum() *S3CompatibleMetadata_NetworkProtocol

func (S3CompatibleMetadata_NetworkProtocol) EnumDescriptor deprecated 

func (S3CompatibleMetadata_NetworkProtocol) EnumDescriptor() ([]byte, []int)

Deprecated: Use S3CompatibleMetadata_NetworkProtocol.Descriptor instead.

func (S3CompatibleMetadata_NetworkProtocol) Number 

func (x S3CompatibleMetadata_NetworkProtocol) Number() protoreflect.EnumNumber

func (S3CompatibleMetadata_NetworkProtocol) String 

func (x S3CompatibleMetadata_NetworkProtocol) String() string

func (S3CompatibleMetadata_NetworkProtocol) Type 

func (S3CompatibleMetadata_NetworkProtocol) Type() protoreflect.EnumType

type S3CompatibleMetadata_RequestModel 

type S3CompatibleMetadata_RequestModel int32

The request model of the API. 

const (
	// RequestModel is not specified.
	S3CompatibleMetadata_REQUEST_MODEL_UNSPECIFIED S3CompatibleMetadata_RequestModel = 0
	// Perform requests using Virtual Hosted Style.
	// Example: https://bucket-name.s3.region.amazonaws.com/key-name
	S3CompatibleMetadata_REQUEST_MODEL_VIRTUAL_HOSTED_STYLE S3CompatibleMetadata_RequestModel = 1
	// Perform requests using Path Style.
	// Example: https://s3.region.amazonaws.com/bucket-name/key-name
	S3CompatibleMetadata_REQUEST_MODEL_PATH_STYLE S3CompatibleMetadata_RequestModel = 2
)

func (S3CompatibleMetadata_RequestModel) Descriptor 

func (S3CompatibleMetadata_RequestModel) Descriptor() protoreflect.EnumDescriptor

func (S3CompatibleMetadata_RequestModel) Enum 

func (x S3CompatibleMetadata_RequestModel) Enum() *S3CompatibleMetadata_RequestModel

func (S3CompatibleMetadata_RequestModel) EnumDescriptor deprecated 

func (S3CompatibleMetadata_RequestModel) EnumDescriptor() ([]byte, []int)

Deprecated: Use S3CompatibleMetadata_RequestModel.Descriptor instead.

func (S3CompatibleMetadata_RequestModel) Number 

func (x S3CompatibleMetadata_RequestModel) Number() protoreflect.EnumNumber

func (S3CompatibleMetadata_RequestModel) String 

func (x S3CompatibleMetadata_RequestModel) String() string

func (S3CompatibleMetadata_RequestModel) Type 

func (S3CompatibleMetadata_RequestModel) Type() protoreflect.EnumType

type Schedule 

type Schedule struct {

	// Required. The start date of a transfer. Date boundaries are determined
	// relative to UTC time. If `schedule_start_date` and
	// [start_time_of_day][google.storagetransfer.v1.Schedule.start_time_of_day]
	// are in the past relative to the job's creation time, the transfer starts
	// the day after you schedule the transfer request.
	//
	// **Note:** When starting jobs at or near midnight UTC it is possible that
	// a job starts later than expected. For example, if you send an outbound
	// request on June 1 one millisecond prior to midnight UTC and the Storage
	// Transfer Service server receives the request on June 2, then it creates
	// a TransferJob with `schedule_start_date` set to June 2 and a
	// `start_time_of_day` set to midnight UTC. The first scheduled
	// [TransferOperation][google.storagetransfer.v1.TransferOperation] takes
	// place on June 3 at midnight UTC.
	ScheduleStartDate *date.Date `protobuf:"bytes,1,opt,name=schedule_start_date,json=scheduleStartDate,proto3" json:"schedule_start_date,omitempty"`
	// The last day a transfer runs. Date boundaries are determined relative to
	// UTC time. A job runs once per 24 hours within the following guidelines:
	//
	// *   If `schedule_end_date` and
	// [schedule_start_date][google.storagetransfer.v1.Schedule.schedule_start_date]
	// are the same and in
	//
	//	the future relative to UTC, the transfer is executed only one time.
	//   - If `schedule_end_date` is later than `schedule_start_date`  and
	//     `schedule_end_date` is in the future relative to UTC, the job runs each
	//     day at
	//     [start_time_of_day][google.storagetransfer.v1.Schedule.start_time_of_day]
	//     through `schedule_end_date`.
	ScheduleEndDate *date.Date `protobuf:"bytes,2,opt,name=schedule_end_date,json=scheduleEndDate,proto3" json:"schedule_end_date,omitempty"`
	// The time in UTC that a transfer job is scheduled to run. Transfers may
	// start later than this time.
	//
	// If `start_time_of_day` is not specified:
	//
	//   - One-time transfers run immediately.
	//   - Recurring transfers run immediately, and each day at midnight UTC,
	//     through
	//     [schedule_end_date][google.storagetransfer.v1.Schedule.schedule_end_date].
	//
	// If `start_time_of_day` is specified:
	//
	//   - One-time transfers run at the specified time.
	//   - Recurring transfers run at the specified time each day, through
	//     `schedule_end_date`.
	StartTimeOfDay *timeofday.TimeOfDay `protobuf:"bytes,3,opt,name=start_time_of_day,json=startTimeOfDay,proto3" json:"start_time_of_day,omitempty"`
	// The time in UTC that no further transfer operations are scheduled. Combined
	// with
	// [schedule_end_date][google.storagetransfer.v1.Schedule.schedule_end_date],
	// `end_time_of_day` specifies the end date and time for starting new transfer
	// operations. This field must be greater than or equal to the timestamp
	// corresponding to the combintation of
	// [schedule_start_date][google.storagetransfer.v1.Schedule.schedule_start_date]
	// and
	// [start_time_of_day][google.storagetransfer.v1.Schedule.start_time_of_day],
	// and is subject to the following:
	//
	//   - If `end_time_of_day` is not set and `schedule_end_date` is set, then
	//     a default value of `23:59:59` is used for `end_time_of_day`.
	//
	//   - If `end_time_of_day` is set and `schedule_end_date` is not set, then
	//     [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] is returned.
	EndTimeOfDay *timeofday.TimeOfDay `protobuf:"bytes,4,opt,name=end_time_of_day,json=endTimeOfDay,proto3" json:"end_time_of_day,omitempty"`
	// Interval between the start of each scheduled TransferOperation. If
	// unspecified, the default value is 24 hours. This value may not be less than
	// 1 hour.
	RepeatInterval *durationpb.Duration `protobuf:"bytes,5,opt,name=repeat_interval,json=repeatInterval,proto3" json:"repeat_interval,omitempty"`
	// contains filtered or unexported fields
}

Transfers can be scheduled to recur or to run just once.

func (*Schedule) Descriptor deprecated 

func (*Schedule) Descriptor() ([]byte, []int)

Deprecated: Use Schedule.ProtoReflect.Descriptor instead.

func (*Schedule) GetEndTimeOfDay 

func (x *Schedule) GetEndTimeOfDay() *timeofday.TimeOfDay

func (*Schedule) GetRepeatInterval 

func (x *Schedule) GetRepeatInterval() *durationpb.Duration

func (*Schedule) GetScheduleEndDate 

func (x *Schedule) GetScheduleEndDate() *date.Date

func (*Schedule) GetScheduleStartDate 

func (x *Schedule) GetScheduleStartDate() *date.Date

func (*Schedule) GetStartTimeOfDay 

func (x *Schedule) GetStartTimeOfDay() *timeofday.TimeOfDay

func (*Schedule) ProtoMessage 

func (*Schedule) ProtoMessage()

func (*Schedule) ProtoReflect 

func (x *Schedule) ProtoReflect() protoreflect.Message

func (*Schedule) Reset 

func (x *Schedule) Reset()

func (*Schedule) String 

func (x *Schedule) String() string

type StorageTransferServiceClient 

type StorageTransferServiceClient interface {
	// 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.
	GetGoogleServiceAccount(ctx context.Context, in *GetGoogleServiceAccountRequest, opts ...grpc.CallOption) (*GoogleServiceAccount, error)
	// Creates a transfer job that runs periodically.
	CreateTransferJob(ctx context.Context, in *CreateTransferJobRequest, opts ...grpc.CallOption) (*TransferJob, error)
	// 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]).
	UpdateTransferJob(ctx context.Context, in *UpdateTransferJobRequest, opts ...grpc.CallOption) (*TransferJob, error)
	// Gets a transfer job.
	GetTransferJob(ctx context.Context, in *GetTransferJobRequest, opts ...grpc.CallOption) (*TransferJob, error)
	// Lists transfer jobs.
	ListTransferJobs(ctx context.Context, in *ListTransferJobsRequest, opts ...grpc.CallOption) (*ListTransferJobsResponse, error)
	// Pauses a transfer operation.
	PauseTransferOperation(ctx context.Context, in *PauseTransferOperationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Resumes a transfer operation that is paused.
	ResumeTransferOperation(ctx context.Context, in *ResumeTransferOperationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// 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.
	RunTransferJob(ctx context.Context, in *RunTransferJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a transfer job. Deleting a transfer job sets its status to
	// [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
	DeleteTransferJob(ctx context.Context, in *DeleteTransferJobRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates an agent pool resource.
	CreateAgentPool(ctx context.Context, in *CreateAgentPoolRequest, opts ...grpc.CallOption) (*AgentPool, error)
	// Updates an existing agent pool resource.
	UpdateAgentPool(ctx context.Context, in *UpdateAgentPoolRequest, opts ...grpc.CallOption) (*AgentPool, error)
	// Gets an agent pool.
	GetAgentPool(ctx context.Context, in *GetAgentPoolRequest, opts ...grpc.CallOption) (*AgentPool, error)
	// Lists agent pools.
	ListAgentPools(ctx context.Context, in *ListAgentPoolsRequest, opts ...grpc.CallOption) (*ListAgentPoolsResponse, error)
	// Deletes an agent pool.
	DeleteAgentPool(ctx context.Context, in *DeleteAgentPoolRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

StorageTransferServiceClient is the client API for StorageTransferService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewStorageTransferServiceClient 

func NewStorageTransferServiceClient(cc grpc.ClientConnInterface) StorageTransferServiceClient

type StorageTransferServiceServer 

type StorageTransferServiceServer interface {
	// 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.
	GetGoogleServiceAccount(context.Context, *GetGoogleServiceAccountRequest) (*GoogleServiceAccount, error)
	// Creates a transfer job that runs periodically.
	CreateTransferJob(context.Context, *CreateTransferJobRequest) (*TransferJob, error)
	// 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]).
	UpdateTransferJob(context.Context, *UpdateTransferJobRequest) (*TransferJob, error)
	// Gets a transfer job.
	GetTransferJob(context.Context, *GetTransferJobRequest) (*TransferJob, error)
	// Lists transfer jobs.
	ListTransferJobs(context.Context, *ListTransferJobsRequest) (*ListTransferJobsResponse, error)
	// Pauses a transfer operation.
	PauseTransferOperation(context.Context, *PauseTransferOperationRequest) (*emptypb.Empty, error)
	// Resumes a transfer operation that is paused.
	ResumeTransferOperation(context.Context, *ResumeTransferOperationRequest) (*emptypb.Empty, error)
	// 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.
	RunTransferJob(context.Context, *RunTransferJobRequest) (*longrunningpb.Operation, error)
	// Deletes a transfer job. Deleting a transfer job sets its status to
	// [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
	DeleteTransferJob(context.Context, *DeleteTransferJobRequest) (*emptypb.Empty, error)
	// Creates an agent pool resource.
	CreateAgentPool(context.Context, *CreateAgentPoolRequest) (*AgentPool, error)
	// Updates an existing agent pool resource.
	UpdateAgentPool(context.Context, *UpdateAgentPoolRequest) (*AgentPool, error)
	// Gets an agent pool.
	GetAgentPool(context.Context, *GetAgentPoolRequest) (*AgentPool, error)
	// Lists agent pools.
	ListAgentPools(context.Context, *ListAgentPoolsRequest) (*ListAgentPoolsResponse, error)
	// Deletes an agent pool.
	DeleteAgentPool(context.Context, *DeleteAgentPoolRequest) (*emptypb.Empty, error)
}

StorageTransferServiceServer is the server API for StorageTransferService service.

type TransferCounters 

type TransferCounters struct {

	// Objects found in the data source that are scheduled to be transferred,
	// excluding any that are filtered based on object conditions or skipped due
	// to sync.
	ObjectsFoundFromSource int64 `` /* 132-byte string literal not displayed */
	// Bytes found in the data source that are scheduled to be transferred,
	// excluding any that are filtered based on object conditions or skipped due
	// to sync.
	BytesFoundFromSource int64 `` /* 126-byte string literal not displayed */
	// Objects found only in the data sink that are scheduled to be deleted.
	ObjectsFoundOnlyFromSink int64 `` /* 140-byte string literal not displayed */
	// Bytes found only in the data sink that are scheduled to be deleted.
	BytesFoundOnlyFromSink int64 `` /* 134-byte string literal not displayed */
	// Objects in the data source that are not transferred because they already
	// exist in the data sink.
	ObjectsFromSourceSkippedBySync int64 `` /* 160-byte string literal not displayed */
	// Bytes in the data source that are not transferred because they already
	// exist in the data sink.
	BytesFromSourceSkippedBySync int64 `` /* 154-byte string literal not displayed */
	// Objects that are copied to the data sink.
	ObjectsCopiedToSink int64 `protobuf:"varint,7,opt,name=objects_copied_to_sink,json=objectsCopiedToSink,proto3" json:"objects_copied_to_sink,omitempty"`
	// Bytes that are copied to the data sink.
	BytesCopiedToSink int64 `protobuf:"varint,8,opt,name=bytes_copied_to_sink,json=bytesCopiedToSink,proto3" json:"bytes_copied_to_sink,omitempty"`
	// Objects that are deleted from the data source.
	ObjectsDeletedFromSource int64 `` /* 138-byte string literal not displayed */
	// Bytes that are deleted from the data source.
	BytesDeletedFromSource int64 `` /* 133-byte string literal not displayed */
	// Objects that are deleted from the data sink.
	ObjectsDeletedFromSink int64 `` /* 133-byte string literal not displayed */
	// Bytes that are deleted from the data sink.
	BytesDeletedFromSink int64 `` /* 127-byte string literal not displayed */
	// Objects in the data source that failed to be transferred or that failed
	// to be deleted after being transferred.
	ObjectsFromSourceFailed int64 `` /* 136-byte string literal not displayed */
	// Bytes in the data source that failed to be transferred or that failed to
	// be deleted after being transferred.
	BytesFromSourceFailed int64 `` /* 130-byte string literal not displayed */
	// Objects that failed to be deleted from the data sink.
	ObjectsFailedToDeleteFromSink int64 `` /* 158-byte string literal not displayed */
	// Bytes that failed to be deleted from the data sink.
	BytesFailedToDeleteFromSink int64 `` /* 152-byte string literal not displayed */
	// For transfers involving PosixFilesystem only.
	//
	// Number of directories found while listing. For example, if the root
	// directory of the transfer is `base/` and there are two other directories,
	// `a/` and `b/` under this directory, the count after listing `base/`,
	// `base/a/` and `base/b/` is 3.
	DirectoriesFoundFromSource int64 `` /* 145-byte string literal not displayed */
	// For transfers involving PosixFilesystem only.
	//
	// Number of listing failures for each directory found at the source.
	// Potential failures when listing a directory include permission failure or
	// block failure. If listing a directory fails, no files in the directory are
	// transferred.
	DirectoriesFailedToListFromSource int64 `` /* 170-byte string literal not displayed */
	// For transfers involving PosixFilesystem only.
	//
	// Number of successful listings for each directory found at the source.
	DirectoriesSuccessfullyListedFromSource int64 `` /* 186-byte string literal not displayed */
	// Number of successfully cleaned up intermediate objects.
	IntermediateObjectsCleanedUp int64 `` /* 151-byte string literal not displayed */
	// Number of intermediate objects failed cleaned up.
	IntermediateObjectsFailedCleanedUp int64 `` /* 171-byte string literal not displayed */
	// contains filtered or unexported fields
}

A collection of counters that report the progress of a transfer operation.

func (*TransferCounters) Descriptor deprecated 

func (*TransferCounters) Descriptor() ([]byte, []int)

Deprecated: Use TransferCounters.ProtoReflect.Descriptor instead.

func (*TransferCounters) GetBytesCopiedToSink 

func (x *TransferCounters) GetBytesCopiedToSink() int64

func (*TransferCounters) GetBytesDeletedFromSink 

func (x *TransferCounters) GetBytesDeletedFromSink() int64

func (*TransferCounters) GetBytesDeletedFromSource 

func (x *TransferCounters) GetBytesDeletedFromSource() int64

func (*TransferCounters) GetBytesFailedToDeleteFromSink 

func (x *TransferCounters) GetBytesFailedToDeleteFromSink() int64

func (*TransferCounters) GetBytesFoundFromSource 

func (x *TransferCounters) GetBytesFoundFromSource() int64

func (*TransferCounters) GetBytesFoundOnlyFromSink 

func (x *TransferCounters) GetBytesFoundOnlyFromSink() int64

func (*TransferCounters) GetBytesFromSourceFailed 

func (x *TransferCounters) GetBytesFromSourceFailed() int64

func (*TransferCounters) GetBytesFromSourceSkippedBySync 

func (x *TransferCounters) GetBytesFromSourceSkippedBySync() int64

func (*TransferCounters) GetDirectoriesFailedToListFromSource 

func (x *TransferCounters) GetDirectoriesFailedToListFromSource() int64

func (*TransferCounters) GetDirectoriesFoundFromSource 

func (x *TransferCounters) GetDirectoriesFoundFromSource() int64

func (*TransferCounters) GetDirectoriesSuccessfullyListedFromSource 

func (x *TransferCounters) GetDirectoriesSuccessfullyListedFromSource() int64

func (*TransferCounters) GetIntermediateObjectsCleanedUp 

func (x *TransferCounters) GetIntermediateObjectsCleanedUp() int64

func (*TransferCounters) GetIntermediateObjectsFailedCleanedUp 

func (x *TransferCounters) GetIntermediateObjectsFailedCleanedUp() int64

func (*TransferCounters) GetObjectsCopiedToSink 

func (x *TransferCounters) GetObjectsCopiedToSink() int64

func (*TransferCounters) GetObjectsDeletedFromSink 

func (x *TransferCounters) GetObjectsDeletedFromSink() int64

func (*TransferCounters) GetObjectsDeletedFromSource 

func (x *TransferCounters) GetObjectsDeletedFromSource() int64

func (*TransferCounters) GetObjectsFailedToDeleteFromSink 

func (x *TransferCounters) GetObjectsFailedToDeleteFromSink() int64

func (*TransferCounters) GetObjectsFoundFromSource 

func (x *TransferCounters) GetObjectsFoundFromSource() int64

func (*TransferCounters) GetObjectsFoundOnlyFromSink 

func (x *TransferCounters) GetObjectsFoundOnlyFromSink() int64

func (*TransferCounters) GetObjectsFromSourceFailed 

func (x *TransferCounters) GetObjectsFromSourceFailed() int64

func (*TransferCounters) GetObjectsFromSourceSkippedBySync 

func (x *TransferCounters) GetObjectsFromSourceSkippedBySync() int64

func (*TransferCounters) ProtoMessage 

func (*TransferCounters) ProtoMessage()

func (*TransferCounters) ProtoReflect 

func (x *TransferCounters) ProtoReflect() protoreflect.Message

func (*TransferCounters) Reset 

func (x *TransferCounters) Reset()

func (*TransferCounters) String 

func (x *TransferCounters) String() string

type TransferJob 

type TransferJob struct {

	// A unique name (within the transfer project) assigned when the job is
	// created.  If this field is empty in a CreateTransferJobRequest, Storage
	// Transfer Service assigns a unique name. Otherwise, the specified name
	// is used as the unique name for this job.
	//
	// If the specified name is in use by a job, the creation request fails with
	// an [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
	//
	// This name must start with `"transferJobs/"` prefix and end with a letter or
	// a number, and should be no more than 128 characters. For transfers
	// involving PosixFilesystem, this name must start with `transferJobs/OPI`
	// specifically. For all other transfer types, this name must not start with
	// `transferJobs/OPI`.
	//
	// Non-PosixFilesystem example:
	// `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"`
	//
	// PosixFilesystem example:
	// `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"`
	//
	// Applications must not rely on the enforcement of naming requirements
	// involving OPI.
	//
	// Invalid job names fail with an
	// [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] error.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A description provided by the user for the job. Its max length is 1024
	// bytes when Unicode-encoded.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// The ID of the Google Cloud project that owns the job.
	ProjectId string `protobuf:"bytes,3,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Transfer specification.
	TransferSpec *TransferSpec `protobuf:"bytes,4,opt,name=transfer_spec,json=transferSpec,proto3" json:"transfer_spec,omitempty"`
	// Notification configuration. This is not supported for transfers involving
	// PosixFilesystem.
	NotificationConfig *NotificationConfig `protobuf:"bytes,11,opt,name=notification_config,json=notificationConfig,proto3" json:"notification_config,omitempty"`
	// Logging configuration.
	LoggingConfig *LoggingConfig `protobuf:"bytes,14,opt,name=logging_config,json=loggingConfig,proto3" json:"logging_config,omitempty"`
	// Specifies schedule for the transfer job.
	// This is an optional field. When the field is not set, the job never
	// executes a transfer, unless you invoke RunTransferJob or update the job to
	// have a non-empty schedule.
	Schedule *Schedule `protobuf:"bytes,5,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// Specifies the event stream for the transfer job for event-driven transfers.
	// When EventStream is specified, the Schedule fields are ignored.
	EventStream *EventStream `protobuf:"bytes,15,opt,name=event_stream,json=eventStream,proto3" json:"event_stream,omitempty"`
	// Status of the job. This value MUST be specified for
	// `CreateTransferJobRequests`.
	//
	// **Note:** The effect of the new job status takes place during a subsequent
	// job run. For example, if you change the job status from
	// [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED] to
	// [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], and an
	// operation spawned by the transfer is running, the status change would not
	// affect the current operation.
	Status TransferJob_Status `protobuf:"varint,6,opt,name=status,proto3,enum=google.storagetransfer.v1.TransferJob_Status" json:"status,omitempty"`
	// Output only. The time that the transfer job was created.
	CreationTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=creation_time,json=creationTime,proto3" json:"creation_time,omitempty"`
	// Output only. The time that the transfer job was last modified.
	LastModificationTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=last_modification_time,json=lastModificationTime,proto3" json:"last_modification_time,omitempty"`
	// Output only. The time that the transfer job was deleted.
	DeletionTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=deletion_time,json=deletionTime,proto3" json:"deletion_time,omitempty"`
	// The name of the most recently started TransferOperation of this JobConfig.
	// Present if a TransferOperation has been created for this JobConfig.
	LatestOperationName string `protobuf:"bytes,12,opt,name=latest_operation_name,json=latestOperationName,proto3" json:"latest_operation_name,omitempty"`
	// contains filtered or unexported fields
}

This resource represents the configuration of a transfer job that runs periodically.

func (*TransferJob) Descriptor deprecated 

func (*TransferJob) Descriptor() ([]byte, []int)

Deprecated: Use TransferJob.ProtoReflect.Descriptor instead.

func (*TransferJob) GetCreationTime 

func (x *TransferJob) GetCreationTime() *timestamppb.Timestamp

func (*TransferJob) GetDeletionTime 

func (x *TransferJob) GetDeletionTime() *timestamppb.Timestamp

func (*TransferJob) GetDescription 

func (x *TransferJob) GetDescription() string

func (*TransferJob) GetEventStream added in v1.10.0 

func (x *TransferJob) GetEventStream() *EventStream

func (*TransferJob) GetLastModificationTime 

func (x *TransferJob) GetLastModificationTime() *timestamppb.Timestamp

func (*TransferJob) GetLatestOperationName 

func (x *TransferJob) GetLatestOperationName() string

func (*TransferJob) GetLoggingConfig 

func (x *TransferJob) GetLoggingConfig() *LoggingConfig

func (*TransferJob) GetName 

func (x *TransferJob) GetName() string

func (*TransferJob) GetNotificationConfig 

func (x *TransferJob) GetNotificationConfig() *NotificationConfig

func (*TransferJob) GetProjectId 

func (x *TransferJob) GetProjectId() string

func (*TransferJob) GetSchedule 

func (x *TransferJob) GetSchedule() *Schedule

func (*TransferJob) GetStatus 

func (x *TransferJob) GetStatus() TransferJob_Status

func (*TransferJob) GetTransferSpec 

func (x *TransferJob) GetTransferSpec() *TransferSpec

func (*TransferJob) ProtoMessage 

func (*TransferJob) ProtoMessage()

func (*TransferJob) ProtoReflect 

func (x *TransferJob) ProtoReflect() protoreflect.Message

func (*TransferJob) Reset 

func (x *TransferJob) Reset()

func (*TransferJob) String 

func (x *TransferJob) String() string

type TransferJob_Status 

type TransferJob_Status int32

The status of the transfer job. 

const (
	// Zero is an illegal value.
	TransferJob_STATUS_UNSPECIFIED TransferJob_Status = 0
	// New transfers are performed based on the schedule.
	TransferJob_ENABLED TransferJob_Status = 1
	// New transfers are not scheduled.
	TransferJob_DISABLED TransferJob_Status = 2
	// This is a soft delete state. After a transfer job is set to this
	// state, the job and all the transfer executions are subject to
	// garbage collection. Transfer jobs become eligible for garbage collection
	// 30 days after their status is set to `DELETED`.
	TransferJob_DELETED TransferJob_Status = 3
)

func (TransferJob_Status) Descriptor 

func (TransferJob_Status) Descriptor() protoreflect.EnumDescriptor

func (TransferJob_Status) Enum 

func (x TransferJob_Status) Enum() *TransferJob_Status

func (TransferJob_Status) EnumDescriptor deprecated 

func (TransferJob_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use TransferJob_Status.Descriptor instead.

func (TransferJob_Status) Number 

func (x TransferJob_Status) Number() protoreflect.EnumNumber

func (TransferJob_Status) String 

func (x TransferJob_Status) String() string

func (TransferJob_Status) Type 

func (TransferJob_Status) Type() protoreflect.EnumType

type TransferManifest 

type TransferManifest struct {

	// Specifies the path to the manifest in Cloud Storage. The Google-managed
	// service account for the transfer must have `storage.objects.get`
	// permission for this object. An example path is
	// `gs://bucket_name/path/manifest.csv`.
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// contains filtered or unexported fields
}

Specifies where the manifest is located.

func (*TransferManifest) Descriptor deprecated 

func (*TransferManifest) Descriptor() ([]byte, []int)

Deprecated: Use TransferManifest.ProtoReflect.Descriptor instead.

func (*TransferManifest) GetLocation 

func (x *TransferManifest) GetLocation() string

func (*TransferManifest) ProtoMessage 

func (*TransferManifest) ProtoMessage()

func (*TransferManifest) ProtoReflect 

func (x *TransferManifest) ProtoReflect() protoreflect.Message

func (*TransferManifest) Reset 

func (x *TransferManifest) Reset()

func (*TransferManifest) String 

func (x *TransferManifest) String() string

type TransferOperation 

type TransferOperation struct {

	// A globally unique ID assigned by the system.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The ID of the Google Cloud project that owns the operation.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Transfer specification.
	TransferSpec *TransferSpec `protobuf:"bytes,3,opt,name=transfer_spec,json=transferSpec,proto3" json:"transfer_spec,omitempty"`
	// Notification configuration.
	NotificationConfig *NotificationConfig `protobuf:"bytes,10,opt,name=notification_config,json=notificationConfig,proto3" json:"notification_config,omitempty"`
	// Cloud Logging configuration.
	LoggingConfig *LoggingConfig `protobuf:"bytes,12,opt,name=logging_config,json=loggingConfig,proto3" json:"logging_config,omitempty"`
	// Start time of this transfer execution.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// End time of this transfer execution.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Status of the transfer operation.
	Status TransferOperation_Status `protobuf:"varint,6,opt,name=status,proto3,enum=google.storagetransfer.v1.TransferOperation_Status" json:"status,omitempty"`
	// Information about the progress of the transfer operation.
	Counters *TransferCounters `protobuf:"bytes,7,opt,name=counters,proto3" json:"counters,omitempty"`
	// Summarizes errors encountered with sample error log entries.
	ErrorBreakdowns []*ErrorSummary `protobuf:"bytes,8,rep,name=error_breakdowns,json=errorBreakdowns,proto3" json:"error_breakdowns,omitempty"`
	// The name of the transfer job that triggers this transfer operation.
	TransferJobName string `protobuf:"bytes,9,opt,name=transfer_job_name,json=transferJobName,proto3" json:"transfer_job_name,omitempty"`
	// contains filtered or unexported fields
}

A description of the execution of a transfer.

func (*TransferOperation) Descriptor deprecated 

func (*TransferOperation) Descriptor() ([]byte, []int)

Deprecated: Use TransferOperation.ProtoReflect.Descriptor instead.

func (*TransferOperation) GetCounters 

func (x *TransferOperation) GetCounters() *TransferCounters

func (*TransferOperation) GetEndTime 

func (x *TransferOperation) GetEndTime() *timestamppb.Timestamp

func (*TransferOperation) GetErrorBreakdowns 

func (x *TransferOperation) GetErrorBreakdowns() []*ErrorSummary

func (*TransferOperation) GetLoggingConfig added in v1.10.0 

func (x *TransferOperation) GetLoggingConfig() *LoggingConfig

func (*TransferOperation) GetName 

func (x *TransferOperation) GetName() string

func (*TransferOperation) GetNotificationConfig 

func (x *TransferOperation) GetNotificationConfig() *NotificationConfig

func (*TransferOperation) GetProjectId 

func (x *TransferOperation) GetProjectId() string

func (*TransferOperation) GetStartTime 

func (x *TransferOperation) GetStartTime() *timestamppb.Timestamp

func (*TransferOperation) GetStatus 

func (x *TransferOperation) GetStatus() TransferOperation_Status

func (*TransferOperation) GetTransferJobName 

func (x *TransferOperation) GetTransferJobName() string

func (*TransferOperation) GetTransferSpec 

func (x *TransferOperation) GetTransferSpec() *TransferSpec

func (*TransferOperation) ProtoMessage 

func (*TransferOperation) ProtoMessage()

func (*TransferOperation) ProtoReflect 

func (x *TransferOperation) ProtoReflect() protoreflect.Message

func (*TransferOperation) Reset 

func (x *TransferOperation) Reset()

func (*TransferOperation) String 

func (x *TransferOperation) String() string

type TransferOperation_Status 

type TransferOperation_Status int32

The status of a TransferOperation. 

const (
	// Zero is an illegal value.
	TransferOperation_STATUS_UNSPECIFIED TransferOperation_Status = 0
	// In progress.
	TransferOperation_IN_PROGRESS TransferOperation_Status = 1
	// Paused.
	TransferOperation_PAUSED TransferOperation_Status = 2
	// Completed successfully.
	TransferOperation_SUCCESS TransferOperation_Status = 3
	// Terminated due to an unrecoverable failure.
	TransferOperation_FAILED TransferOperation_Status = 4
	// Aborted by the user.
	TransferOperation_ABORTED TransferOperation_Status = 5
	// Temporarily delayed by the system. No user action is required.
	TransferOperation_QUEUED TransferOperation_Status = 6
	// The operation is suspending and draining the ongoing work to completion.
	TransferOperation_SUSPENDING TransferOperation_Status = 7
)

func (TransferOperation_Status) Descriptor 

func (TransferOperation_Status) Descriptor() protoreflect.EnumDescriptor

func (TransferOperation_Status) Enum 

func (x TransferOperation_Status) Enum() *TransferOperation_Status

func (TransferOperation_Status) EnumDescriptor deprecated 

func (TransferOperation_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use TransferOperation_Status.Descriptor instead.

func (TransferOperation_Status) Number 

func (x TransferOperation_Status) Number() protoreflect.EnumNumber

func (TransferOperation_Status) String 

func (x TransferOperation_Status) String() string

func (TransferOperation_Status) Type 

func (TransferOperation_Status) Type() protoreflect.EnumType

type TransferOptions 

type TransferOptions struct {

	// When to overwrite objects that already exist in the sink. The default is
	// that only objects that are different from the source are ovewritten. If
	// true, all objects in the sink whose name matches an object in the source
	// are overwritten with the source object.
	OverwriteObjectsAlreadyExistingInSink bool `` /* 181-byte string literal not displayed */
	// Whether objects that exist only in the sink should be deleted.
	//
	// **Note:** This option and
	// [delete_objects_from_source_after_transfer][google.storagetransfer.v1.TransferOptions.delete_objects_from_source_after_transfer]
	// are mutually exclusive.
	DeleteObjectsUniqueInSink bool `` /* 143-byte string literal not displayed */
	// Whether objects should be deleted from the source after they are
	// transferred to the sink.
	//
	// **Note:** This option and
	// [delete_objects_unique_in_sink][google.storagetransfer.v1.TransferOptions.delete_objects_unique_in_sink]
	// are mutually exclusive.
	DeleteObjectsFromSourceAfterTransfer bool `` /* 178-byte string literal not displayed */
	// When to overwrite objects that already exist in the sink. If not set,
	// overwrite behavior is determined by
	// [overwrite_objects_already_existing_in_sink][google.storagetransfer.v1.TransferOptions.overwrite_objects_already_existing_in_sink].
	OverwriteWhen TransferOptions_OverwriteWhen `` /* 162-byte string literal not displayed */
	// Represents the selected metadata options for a transfer job.
	MetadataOptions *MetadataOptions `protobuf:"bytes,5,opt,name=metadata_options,json=metadataOptions,proto3" json:"metadata_options,omitempty"`
	// contains filtered or unexported fields
}

TransferOptions define the actions to be performed on objects in a transfer.

func (*TransferOptions) Descriptor deprecated 

func (*TransferOptions) Descriptor() ([]byte, []int)

Deprecated: Use TransferOptions.ProtoReflect.Descriptor instead.

func (*TransferOptions) GetDeleteObjectsFromSourceAfterTransfer 

func (x *TransferOptions) GetDeleteObjectsFromSourceAfterTransfer() bool

func (*TransferOptions) GetDeleteObjectsUniqueInSink 

func (x *TransferOptions) GetDeleteObjectsUniqueInSink() bool

func (*TransferOptions) GetMetadataOptions 

func (x *TransferOptions) GetMetadataOptions() *MetadataOptions

func (*TransferOptions) GetOverwriteObjectsAlreadyExistingInSink 

func (x *TransferOptions) GetOverwriteObjectsAlreadyExistingInSink() bool

func (*TransferOptions) GetOverwriteWhen 

func (x *TransferOptions) GetOverwriteWhen() TransferOptions_OverwriteWhen

func (*TransferOptions) ProtoMessage 

func (*TransferOptions) ProtoMessage()

func (*TransferOptions) ProtoReflect 

func (x *TransferOptions) ProtoReflect() protoreflect.Message

func (*TransferOptions) Reset 

func (x *TransferOptions) Reset()

func (*TransferOptions) String 

func (x *TransferOptions) String() string

type TransferOptions_OverwriteWhen 

type TransferOptions_OverwriteWhen int32

Specifies when to overwrite an object in the sink when an object with matching name is found in the source. 

const (
	// Overwrite behavior is unspecified.
	TransferOptions_OVERWRITE_WHEN_UNSPECIFIED TransferOptions_OverwriteWhen = 0
	// Overwrites destination objects with the source objects, only if the
	// objects have the same name but different HTTP ETags or checksum values.
	TransferOptions_DIFFERENT TransferOptions_OverwriteWhen = 1
	// Never overwrites a destination object if a source object has the
	// same name. In this case, the source object is not transferred.
	TransferOptions_NEVER TransferOptions_OverwriteWhen = 2
	// Always overwrite the destination object with the source object, even if
	// the HTTP Etags or checksum values are the same.
	TransferOptions_ALWAYS TransferOptions_OverwriteWhen = 3
)

func (TransferOptions_OverwriteWhen) Descriptor 

func (TransferOptions_OverwriteWhen) Descriptor() protoreflect.EnumDescriptor

func (TransferOptions_OverwriteWhen) Enum 

func (x TransferOptions_OverwriteWhen) Enum() *TransferOptions_OverwriteWhen

func (TransferOptions_OverwriteWhen) EnumDescriptor deprecated 

func (TransferOptions_OverwriteWhen) EnumDescriptor() ([]byte, []int)

Deprecated: Use TransferOptions_OverwriteWhen.Descriptor instead.

func (TransferOptions_OverwriteWhen) Number 

func (x TransferOptions_OverwriteWhen) Number() protoreflect.EnumNumber

func (TransferOptions_OverwriteWhen) String 

func (x TransferOptions_OverwriteWhen) String() string

func (TransferOptions_OverwriteWhen) Type 

func (TransferOptions_OverwriteWhen) Type() protoreflect.EnumType

type TransferSpec 

type TransferSpec struct {

	// The write sink for the data.
	//
	// Types that are assignable to DataSink:
	//
	//	*TransferSpec_GcsDataSink
	//	*TransferSpec_PosixDataSink
	DataSink isTransferSpec_DataSink `protobuf_oneof:"data_sink"`
	// The read source of the data.
	//
	// Types that are assignable to DataSource:
	//
	//	*TransferSpec_GcsDataSource
	//	*TransferSpec_AwsS3DataSource
	//	*TransferSpec_HttpDataSource
	//	*TransferSpec_PosixDataSource
	//	*TransferSpec_AzureBlobStorageDataSource
	//	*TransferSpec_AwsS3CompatibleDataSource
	DataSource isTransferSpec_DataSource `protobuf_oneof:"data_source"`
	// Types that are assignable to IntermediateDataLocation:
	//
	//	*TransferSpec_GcsIntermediateDataLocation
	IntermediateDataLocation isTransferSpec_IntermediateDataLocation `protobuf_oneof:"intermediate_data_location"`
	// Only objects that satisfy these object conditions are included in the set
	// of data source and data sink objects.  Object conditions based on
	// objects' "last modification time" do not exclude objects in a data sink.
	ObjectConditions *ObjectConditions `protobuf:"bytes,5,opt,name=object_conditions,json=objectConditions,proto3" json:"object_conditions,omitempty"`
	// If the option
	// [delete_objects_unique_in_sink][google.storagetransfer.v1.TransferOptions.delete_objects_unique_in_sink]
	// is `true` and time-based object conditions such as 'last modification time'
	// are specified, the request fails with an
	// [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] error.
	TransferOptions *TransferOptions `protobuf:"bytes,6,opt,name=transfer_options,json=transferOptions,proto3" json:"transfer_options,omitempty"`
	// A manifest file provides a list of objects to be transferred from the data
	// source. This field points to the location of the manifest file.
	// Otherwise, the entire source bucket is used. ObjectConditions still apply.
	TransferManifest *TransferManifest `protobuf:"bytes,15,opt,name=transfer_manifest,json=transferManifest,proto3" json:"transfer_manifest,omitempty"`
	// Specifies the agent pool name associated with the posix data source. When
	// unspecified, the default name is used.
	SourceAgentPoolName string `protobuf:"bytes,17,opt,name=source_agent_pool_name,json=sourceAgentPoolName,proto3" json:"source_agent_pool_name,omitempty"`
	// Specifies the agent pool name associated with the posix data sink. When
	// unspecified, the default name is used.
	SinkAgentPoolName string `protobuf:"bytes,18,opt,name=sink_agent_pool_name,json=sinkAgentPoolName,proto3" json:"sink_agent_pool_name,omitempty"`
	// contains filtered or unexported fields
}

Configuration for running a transfer.

func (*TransferSpec) Descriptor deprecated 

func (*TransferSpec) Descriptor() ([]byte, []int)

Deprecated: Use TransferSpec.ProtoReflect.Descriptor instead.

func (*TransferSpec) GetAwsS3CompatibleDataSource 

func (x *TransferSpec) GetAwsS3CompatibleDataSource() *AwsS3CompatibleData

func (*TransferSpec) GetAwsS3DataSource 

func (x *TransferSpec) GetAwsS3DataSource() *AwsS3Data

func (*TransferSpec) GetAzureBlobStorageDataSource 

func (x *TransferSpec) GetAzureBlobStorageDataSource() *AzureBlobStorageData

func (*TransferSpec) GetDataSink 

func (m *TransferSpec) GetDataSink() isTransferSpec_DataSink

func (*TransferSpec) GetDataSource 

func (m *TransferSpec) GetDataSource() isTransferSpec_DataSource

func (*TransferSpec) GetGcsDataSink 

func (x *TransferSpec) GetGcsDataSink() *GcsData

func (*TransferSpec) GetGcsDataSource 

func (x *TransferSpec) GetGcsDataSource() *GcsData

func (*TransferSpec) GetGcsIntermediateDataLocation 

func (x *TransferSpec) GetGcsIntermediateDataLocation() *GcsData

func (*TransferSpec) GetHttpDataSource 

func (x *TransferSpec) GetHttpDataSource() *HttpData

func (*TransferSpec) GetIntermediateDataLocation 

func (m *TransferSpec) GetIntermediateDataLocation() isTransferSpec_IntermediateDataLocation

func (*TransferSpec) GetObjectConditions 

func (x *TransferSpec) GetObjectConditions() *ObjectConditions

func (*TransferSpec) GetPosixDataSink 

func (x *TransferSpec) GetPosixDataSink() *PosixFilesystem

func (*TransferSpec) GetPosixDataSource 

func (x *TransferSpec) GetPosixDataSource() *PosixFilesystem

func (*TransferSpec) GetSinkAgentPoolName 

func (x *TransferSpec) GetSinkAgentPoolName() string

func (*TransferSpec) GetSourceAgentPoolName 

func (x *TransferSpec) GetSourceAgentPoolName() string

func (*TransferSpec) GetTransferManifest 

func (x *TransferSpec) GetTransferManifest() *TransferManifest

func (*TransferSpec) GetTransferOptions 

func (x *TransferSpec) GetTransferOptions() *TransferOptions

func (*TransferSpec) ProtoMessage 

func (*TransferSpec) ProtoMessage()

func (*TransferSpec) ProtoReflect 

func (x *TransferSpec) ProtoReflect() protoreflect.Message

func (*TransferSpec) Reset 

func (x *TransferSpec) Reset()

func (*TransferSpec) String 

func (x *TransferSpec) String() string

type TransferSpec_AwsS3CompatibleDataSource 

type TransferSpec_AwsS3CompatibleDataSource struct {
	// An AWS S3 compatible data source.
	AwsS3CompatibleDataSource *AwsS3CompatibleData `protobuf:"bytes,19,opt,name=aws_s3_compatible_data_source,json=awsS3CompatibleDataSource,proto3,oneof"`
}

type TransferSpec_AwsS3DataSource 

type TransferSpec_AwsS3DataSource struct {
	// An AWS S3 data source.
	AwsS3DataSource *AwsS3Data `protobuf:"bytes,2,opt,name=aws_s3_data_source,json=awsS3DataSource,proto3,oneof"`
}

type TransferSpec_AzureBlobStorageDataSource 

type TransferSpec_AzureBlobStorageDataSource struct {
	// An Azure Blob Storage data source.
	AzureBlobStorageDataSource *AzureBlobStorageData `protobuf:"bytes,8,opt,name=azure_blob_storage_data_source,json=azureBlobStorageDataSource,proto3,oneof"`
}

type TransferSpec_GcsDataSink 

type TransferSpec_GcsDataSink struct {
	// A Cloud Storage data sink.
	GcsDataSink *GcsData `protobuf:"bytes,4,opt,name=gcs_data_sink,json=gcsDataSink,proto3,oneof"`
}

type TransferSpec_GcsDataSource 

type TransferSpec_GcsDataSource struct {
	// A Cloud Storage data source.
	GcsDataSource *GcsData `protobuf:"bytes,1,opt,name=gcs_data_source,json=gcsDataSource,proto3,oneof"`
}

type TransferSpec_GcsIntermediateDataLocation 

type TransferSpec_GcsIntermediateDataLocation struct {
	// For transfers between file systems, specifies a Cloud Storage bucket
	// to be used as an intermediate location through which to transfer data.
	//
	// See [Transfer data between file
	// systems](https://cloud.google.com/storage-transfer/docs/file-to-file) for
	// more information.
	GcsIntermediateDataLocation *GcsData `protobuf:"bytes,16,opt,name=gcs_intermediate_data_location,json=gcsIntermediateDataLocation,proto3,oneof"`
}

type TransferSpec_HttpDataSource 

type TransferSpec_HttpDataSource struct {
	// An HTTP URL data source.
	HttpDataSource *HttpData `protobuf:"bytes,3,opt,name=http_data_source,json=httpDataSource,proto3,oneof"`
}

type TransferSpec_PosixDataSink 

type TransferSpec_PosixDataSink struct {
	// A POSIX Filesystem data sink.
	PosixDataSink *PosixFilesystem `protobuf:"bytes,13,opt,name=posix_data_sink,json=posixDataSink,proto3,oneof"`
}

type TransferSpec_PosixDataSource 

type TransferSpec_PosixDataSource struct {
	// A POSIX Filesystem data source.
	PosixDataSource *PosixFilesystem `protobuf:"bytes,14,opt,name=posix_data_source,json=posixDataSource,proto3,oneof"`
}

type UnimplementedStorageTransferServiceServer 

type UnimplementedStorageTransferServiceServer struct {
}

UnimplementedStorageTransferServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedStorageTransferServiceServer) CreateAgentPool 

func (*UnimplementedStorageTransferServiceServer) CreateAgentPool(context.Context, *CreateAgentPoolRequest) (*AgentPool, error)

func (*UnimplementedStorageTransferServiceServer) CreateTransferJob 

func (*UnimplementedStorageTransferServiceServer) CreateTransferJob(context.Context, *CreateTransferJobRequest) (*TransferJob, error)

func (*UnimplementedStorageTransferServiceServer) DeleteAgentPool 

func (*UnimplementedStorageTransferServiceServer) DeleteAgentPool(context.Context, *DeleteAgentPoolRequest) (*emptypb.Empty, error)

func (*UnimplementedStorageTransferServiceServer) DeleteTransferJob 

func (*UnimplementedStorageTransferServiceServer) DeleteTransferJob(context.Context, *DeleteTransferJobRequest) (*emptypb.Empty, error)

func (*UnimplementedStorageTransferServiceServer) GetAgentPool 

func (*UnimplementedStorageTransferServiceServer) GetAgentPool(context.Context, *GetAgentPoolRequest) (*AgentPool, error)

func (*UnimplementedStorageTransferServiceServer) GetGoogleServiceAccount 

func (*UnimplementedStorageTransferServiceServer) GetGoogleServiceAccount(context.Context, *GetGoogleServiceAccountRequest) (*GoogleServiceAccount, error)

func (*UnimplementedStorageTransferServiceServer) GetTransferJob 

func (*UnimplementedStorageTransferServiceServer) GetTransferJob(context.Context, *GetTransferJobRequest) (*TransferJob, error)

func (*UnimplementedStorageTransferServiceServer) ListAgentPools 

func (*UnimplementedStorageTransferServiceServer) ListAgentPools(context.Context, *ListAgentPoolsRequest) (*ListAgentPoolsResponse, error)

func (*UnimplementedStorageTransferServiceServer) ListTransferJobs 

func (*UnimplementedStorageTransferServiceServer) ListTransferJobs(context.Context, *ListTransferJobsRequest) (*ListTransferJobsResponse, error)

func (*UnimplementedStorageTransferServiceServer) PauseTransferOperation 

func (*UnimplementedStorageTransferServiceServer) PauseTransferOperation(context.Context, *PauseTransferOperationRequest) (*emptypb.Empty, error)

func (*UnimplementedStorageTransferServiceServer) ResumeTransferOperation 

func (*UnimplementedStorageTransferServiceServer) ResumeTransferOperation(context.Context, *ResumeTransferOperationRequest) (*emptypb.Empty, error)

func (*UnimplementedStorageTransferServiceServer) RunTransferJob 

func (*UnimplementedStorageTransferServiceServer) RunTransferJob(context.Context, *RunTransferJobRequest) (*longrunningpb.Operation, error)

func (*UnimplementedStorageTransferServiceServer) UpdateAgentPool 

func (*UnimplementedStorageTransferServiceServer) UpdateAgentPool(context.Context, *UpdateAgentPoolRequest) (*AgentPool, error)

func (*UnimplementedStorageTransferServiceServer) UpdateTransferJob 

func (*UnimplementedStorageTransferServiceServer) UpdateTransferJob(context.Context, *UpdateTransferJobRequest) (*TransferJob, error)

type UpdateAgentPoolRequest 

type UpdateAgentPoolRequest struct {

	// 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].
	AgentPool *AgentPool `protobuf:"bytes,1,opt,name=agent_pool,json=agentPool,proto3" json:"agent_pool,omitempty"`
	// 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]
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Specifies the request passed to UpdateAgentPool.

func (*UpdateAgentPoolRequest) Descriptor deprecated 

func (*UpdateAgentPoolRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateAgentPoolRequest.ProtoReflect.Descriptor instead.

func (*UpdateAgentPoolRequest) GetAgentPool 

func (x *UpdateAgentPoolRequest) GetAgentPool() *AgentPool

func (*UpdateAgentPoolRequest) GetUpdateMask 

func (x *UpdateAgentPoolRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateAgentPoolRequest) ProtoMessage 

func (*UpdateAgentPoolRequest) ProtoMessage()

func (*UpdateAgentPoolRequest) ProtoReflect 

func (x *UpdateAgentPoolRequest) ProtoReflect() protoreflect.Message

func (*UpdateAgentPoolRequest) Reset 

func (x *UpdateAgentPoolRequest) Reset()

func (*UpdateAgentPoolRequest) String 

func (x *UpdateAgentPoolRequest) String() string

type UpdateTransferJobRequest 

type UpdateTransferJobRequest struct {

	// Required. The name of job to update.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// Required. The ID of the Google Cloud project that owns the
	// job.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The job to update. `transferJob` is expected to specify one or
	// more of five fields:
	// [description][google.storagetransfer.v1.TransferJob.description],
	// [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec],
	// [notification_config][google.storagetransfer.v1.TransferJob.notification_config],
	// [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and
	// [status][google.storagetransfer.v1.TransferJob.status].  An
	// `UpdateTransferJobRequest` that specifies other fields are rejected with
	// the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. Updating a
	// job status to
	// [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED] requires
	// `storagetransfer.jobs.delete` permission.
	TransferJob *TransferJob `protobuf:"bytes,3,opt,name=transfer_job,json=transferJob,proto3" json:"transfer_job,omitempty"`
	// The field mask of the fields in `transferJob` that are to be updated in
	// this request.  Fields in `transferJob` that can be updated are:
	// [description][google.storagetransfer.v1.TransferJob.description],
	// [transfer_spec][google.storagetransfer.v1.TransferJob.transfer_spec],
	// [notification_config][google.storagetransfer.v1.TransferJob.notification_config],
	// [logging_config][google.storagetransfer.v1.TransferJob.logging_config], and
	// [status][google.storagetransfer.v1.TransferJob.status].  To update the
	// `transfer_spec` of the job, a complete transfer specification must be
	// provided. An incomplete specification missing any required fields is
	// rejected with the error
	// [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].
	UpdateTransferJobFieldMask *fieldmaskpb.FieldMask `` /* 145-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request passed to UpdateTransferJob.

func (*UpdateTransferJobRequest) Descriptor deprecated 

func (*UpdateTransferJobRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTransferJobRequest.ProtoReflect.Descriptor instead.

func (*UpdateTransferJobRequest) GetJobName 

func (x *UpdateTransferJobRequest) GetJobName() string

func (*UpdateTransferJobRequest) GetProjectId 

func (x *UpdateTransferJobRequest) GetProjectId() string

func (*UpdateTransferJobRequest) GetTransferJob 

func (x *UpdateTransferJobRequest) GetTransferJob() *TransferJob

func (*UpdateTransferJobRequest) GetUpdateTransferJobFieldMask 

func (x *UpdateTransferJobRequest) GetUpdateTransferJobFieldMask() *fieldmaskpb.FieldMask

func (*UpdateTransferJobRequest) ProtoMessage 

func (*UpdateTransferJobRequest) ProtoMessage()

func (*UpdateTransferJobRequest) ProtoReflect 

func (x *UpdateTransferJobRequest) ProtoReflect() protoreflect.Message

func (*UpdateTransferJobRequest) Reset 

func (x *UpdateTransferJobRequest) Reset()

func (*UpdateTransferJobRequest) String 

func (x *UpdateTransferJobRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.