Package cloud.google.com/go/storagetransfer/apiv1/storagetransferpb (v1.5.0)

Variables

S3CompatibleMetadata_AuthMethod_name, S3CompatibleMetadata_AuthMethod_value

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.

S3CompatibleMetadata_RequestModel_name, S3CompatibleMetadata_RequestModel_value

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.

S3CompatibleMetadata_NetworkProtocol_name, S3CompatibleMetadata_NetworkProtocol_value

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.

S3CompatibleMetadata_ListApi_name, S3CompatibleMetadata_ListApi_value

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.

AgentPool_State_name, AgentPool_State_value

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.

TransferOptions_OverwriteWhen_name, TransferOptions_OverwriteWhen_value

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.

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.

MetadataOptions_Mode_name, MetadataOptions_Mode_value

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.

MetadataOptions_GID_name, MetadataOptions_GID_value

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.

MetadataOptions_UID_name, MetadataOptions_UID_value

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.

MetadataOptions_Acl_name, MetadataOptions_Acl_value

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.

MetadataOptions_StorageClass_name, MetadataOptions_StorageClass_value

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.

MetadataOptions_TemporaryHold_name, MetadataOptions_TemporaryHold_value

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.

MetadataOptions_KmsKey_name, MetadataOptions_KmsKey_value

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.

MetadataOptions_TimeCreated_name, MetadataOptions_TimeCreated_value

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.

TransferJob_Status_name, TransferJob_Status_value

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.

NotificationConfig_EventType_name, NotificationConfig_EventType_value

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.

NotificationConfig_PayloadFormat_name, NotificationConfig_PayloadFormat_value

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.

LoggingConfig_LoggableAction_name, LoggingConfig_LoggableAction_value

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.

LoggingConfig_LoggableActionState_name, LoggingConfig_LoggableActionState_value

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.

TransferOperation_Status_name, TransferOperation_Status_value

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

Enum value maps for TransferOperation_Status.

File_google_storagetransfer_v1_transfer_proto

var File_google_storagetransfer_v1_transfer_proto protoreflect.FileDescriptor

File_google_storagetransfer_v1_transfer_types_proto

var File_google_storagetransfer_v1_transfer_types_proto protoreflect.FileDescriptor

Functions

func RegisterStorageTransferServiceServer

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

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

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

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

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

AgentPool_State

type AgentPool_State int32

The state of an AgentPool.

AgentPool_STATE_UNSPECIFIED, AgentPool_CREATING, AgentPool_CREATED, AgentPool_DELETING

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) Enum

func (x AgentPool_State) Enum() *AgentPool_State

func (AgentPool_State) EnumDescriptor

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

Deprecated: Use AgentPool_State.Descriptor instead.

func (AgentPool_State) Number

func (AgentPool_State) String

func (x AgentPool_State) String() string

func (AgentPool_State) 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).

For information on our data retention policy for user credentials, see User credentials.

func (*AwsAccessKey) Descriptor

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

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

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

AwsS3CompatibleData_S3Metadata

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

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"`
	// 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

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) 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

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"`
	// 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. In an AzureBlobStorageData resource, a blobs's name is the Azure Blob Storage blob's key name.

func (*AzureBlobStorageData) Descriptor

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) 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

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.

func (*AzureCredentials) Descriptor

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 (*GetGoogleServiceAccountRequest) Reset

func (x *GetGoogleServiceAccountRequest) Reset()

func (*GetGoogleServiceAccountRequest) String

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

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

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

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

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.

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 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

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

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

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

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

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

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

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

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

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

LoggingConfig

type LoggingConfig struct {
	LogActions []LoggingConfig_LoggableAction "" /* 159 byte string literal not displayed */

	LogActionStates []LoggingConfig_LoggableActionState "" /* 181 byte string literal not displayed */

	EnableOnpremGcsTransferLogs bool "" /* 149 byte string literal not displayed */

}

Specifies the logging behavior for transfer operations.

For cloud-to-cloud transfers, logs are sent to Cloud Logging. See 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 for details.

func (*LoggingConfig) Descriptor

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

LoggingConfig_LoggableAction

type LoggingConfig_LoggableAction int32

Loggable actions.

LoggingConfig_LOGGABLE_ACTION_UNSPECIFIED, LoggingConfig_FIND, LoggingConfig_DELETE, LoggingConfig_COPY

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) Enum

func (LoggingConfig_LoggableAction) EnumDescriptor

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

Deprecated: Use LoggingConfig_LoggableAction.Descriptor instead.

func (LoggingConfig_LoggableAction) Number

func (LoggingConfig_LoggableAction) String

func (LoggingConfig_LoggableAction) Type

LoggingConfig_LoggableActionState

type LoggingConfig_LoggableActionState int32

Loggable action states.

LoggingConfig_LOGGABLE_ACTION_STATE_UNSPECIFIED, LoggingConfig_SUCCEEDED, LoggingConfig_FAILED

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) Enum

func (LoggingConfig_LoggableActionState) EnumDescriptor

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

Deprecated: Use LoggingConfig_LoggableActionState.Descriptor instead.

func (LoggingConfig_LoggableActionState) Number

func (LoggingConfig_LoggableActionState) String

func (LoggingConfig_LoggableActionState) Type

MetadataOptions

type MetadataOptions struct {
	Symlink MetadataOptions_Symlink `protobuf:"varint,1,opt,name=symlink,proto3,enum=google.storagetransfer.v1.MetadataOptions_Symlink" json:"symlink,omitempty"`

	Mode MetadataOptions_Mode `protobuf:"varint,2,opt,name=mode,proto3,enum=google.storagetransfer.v1.MetadataOptions_Mode" json:"mode,omitempty"`

	Gid MetadataOptions_GID `protobuf:"varint,3,opt,name=gid,proto3,enum=google.storagetransfer.v1.MetadataOptions_GID" json:"gid,omitempty"`

	Uid MetadataOptions_UID `protobuf:"varint,4,opt,name=uid,proto3,enum=google.storagetransfer.v1.MetadataOptions_UID" json:"uid,omitempty"`

	Acl MetadataOptions_Acl `protobuf:"varint,5,opt,name=acl,proto3,enum=google.storagetransfer.v1.MetadataOptions_Acl" json:"acl,omitempty"`

	StorageClass MetadataOptions_StorageClass "" /* 158 byte string literal not displayed */

	TemporaryHold MetadataOptions_TemporaryHold "" /* 162 byte string literal not displayed */

	KmsKey MetadataOptions_KmsKey "" /* 134 byte string literal not displayed */

	TimeCreated MetadataOptions_TimeCreated "" /* 154 byte string literal not displayed */

}

Specifies the metadata options for running a transfer.

func (*MetadataOptions) Descriptor

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

Deprecated: Use MetadataOptions.ProtoReflect.Descriptor instead.

func (*MetadataOptions) GetAcl

func (*MetadataOptions) GetGid

func (*MetadataOptions) GetKmsKey

func (x *MetadataOptions) GetKmsKey() MetadataOptions_KmsKey

func (*MetadataOptions) GetMode

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 (*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

MetadataOptions_Acl

type MetadataOptions_Acl int32

Options for handling Cloud Storage object ACLs.

MetadataOptions_ACL_UNSPECIFIED, MetadataOptions_ACL_DESTINATION_BUCKET_DEFAULT, MetadataOptions_ACL_PRESERVE

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) Enum

func (MetadataOptions_Acl) EnumDescriptor

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

Deprecated: Use MetadataOptions_Acl.Descriptor instead.

func (MetadataOptions_Acl) Number

func (MetadataOptions_Acl) String

func (x MetadataOptions_Acl) String() string

func (MetadataOptions_Acl) Type

MetadataOptions_GID

type MetadataOptions_GID int32

Options for handling file GID attribute.

MetadataOptions_GID_UNSPECIFIED, MetadataOptions_GID_SKIP, MetadataOptions_GID_NUMBER

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) Enum

func (MetadataOptions_GID) EnumDescriptor

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

Deprecated: Use MetadataOptions_GID.Descriptor instead.

func (MetadataOptions_GID) Number

func (MetadataOptions_GID) String

func (x MetadataOptions_GID) String() string

func (MetadataOptions_GID) Type

MetadataOptions_KmsKey

type MetadataOptions_KmsKey int32

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

MetadataOptions_KMS_KEY_UNSPECIFIED, MetadataOptions_KMS_KEY_DESTINATION_BUCKET_DEFAULT, MetadataOptions_KMS_KEY_PRESERVE

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) Enum

func (MetadataOptions_KmsKey) EnumDescriptor

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

Deprecated: Use MetadataOptions_KmsKey.Descriptor instead.

func (MetadataOptions_KmsKey) Number

func (MetadataOptions_KmsKey) String

func (x MetadataOptions_KmsKey) String() string

func (MetadataOptions_KmsKey) Type

MetadataOptions_Mode

type MetadataOptions_Mode int32

Options for handling file mode attribute.

MetadataOptions_MODE_UNSPECIFIED, MetadataOptions_MODE_SKIP, MetadataOptions_MODE_PRESERVE

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) Enum

func (MetadataOptions_Mode) EnumDescriptor

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

Deprecated: Use MetadataOptions_Mode.Descriptor instead.

func (MetadataOptions_Mode) Number

func (MetadataOptions_Mode) String

func (x MetadataOptions_Mode) String() string

func (MetadataOptions_Mode) Type

MetadataOptions_StorageClass

type MetadataOptions_StorageClass int32

Options for handling Google Cloud Storage object storage class.

MetadataOptions_STORAGE_CLASS_UNSPECIFIED, MetadataOptions_STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT, MetadataOptions_STORAGE_CLASS_PRESERVE, MetadataOptions_STORAGE_CLASS_STANDARD, MetadataOptions_STORAGE_CLASS_NEARLINE, MetadataOptions_STORAGE_CLASS_COLDLINE, MetadataOptions_STORAGE_CLASS_ARCHIVE

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.
	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) Enum

func (MetadataOptions_StorageClass) EnumDescriptor

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

Deprecated: Use MetadataOptions_StorageClass.Descriptor instead.

func (MetadataOptions_StorageClass) Number

func (MetadataOptions_StorageClass) String

func (MetadataOptions_StorageClass) Type

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) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetadataOptions_Symlink.Descriptor instead.

func (x MetadataOptions_Symlink) String() string

MetadataOptions_TemporaryHold

type MetadataOptions_TemporaryHold int32

Options for handling temporary holds for Google Cloud Storage objects.

MetadataOptions_TEMPORARY_HOLD_UNSPECIFIED, MetadataOptions_TEMPORARY_HOLD_SKIP, MetadataOptions_TEMPORARY_HOLD_PRESERVE

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) Enum

func (MetadataOptions_TemporaryHold) EnumDescriptor

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

Deprecated: Use MetadataOptions_TemporaryHold.Descriptor instead.

func (MetadataOptions_TemporaryHold) Number

func (MetadataOptions_TemporaryHold) String

func (MetadataOptions_TemporaryHold) Type

MetadataOptions_TimeCreated

type MetadataOptions_TimeCreated int32

Options for handling timeCreated metadata for Google Cloud Storage objects.

MetadataOptions_TIME_CREATED_UNSPECIFIED, MetadataOptions_TIME_CREATED_SKIP, MetadataOptions_TIME_CREATED_PRESERVE_AS_CUSTOM_TIME

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) Enum

func (MetadataOptions_TimeCreated) EnumDescriptor

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

Deprecated: Use MetadataOptions_TimeCreated.Descriptor instead.

func (MetadataOptions_TimeCreated) Number

func (MetadataOptions_TimeCreated) String

func (MetadataOptions_TimeCreated) Type

MetadataOptions_UID

type MetadataOptions_UID int32

Options for handling file UID attribute.

MetadataOptions_UID_UNSPECIFIED, MetadataOptions_UID_SKIP, MetadataOptions_UID_NUMBER

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) Enum

func (MetadataOptions_UID) EnumDescriptor

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

Deprecated: Use MetadataOptions_UID.Descriptor instead.

func (MetadataOptions_UID) Number

func (MetadataOptions_UID) String

func (x MetadataOptions_UID) String() string

func (MetadataOptions_UID) Type

NotificationConfig

type NotificationConfig struct {
	PubsubTopic string `protobuf:"bytes,1,opt,name=pubsub_topic,json=pubsubTopic,proto3" json:"pubsub_topic,omitempty"`

	EventTypes []NotificationConfig_EventType "" /* 159 byte string literal not displayed */

	PayloadFormat NotificationConfig_PayloadFormat "" /* 165 byte string literal not displayed */

}

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

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

Deprecated: Use NotificationConfig.ProtoReflect.Descriptor instead.

func (*NotificationConfig) GetEventTypes

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

func (*NotificationConfig) GetPayloadFormat

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

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.

NotificationConfig_EVENT_TYPE_UNSPECIFIED, NotificationConfig_TRANSFER_OPERATION_SUCCESS, NotificationConfig_TRANSFER_OPERATION_FAILED, NotificationConfig_TRANSFER_OPERATION_ABORTED

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) Enum

func (NotificationConfig_EventType) EnumDescriptor

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

Deprecated: Use NotificationConfig_EventType.Descriptor instead.

func (NotificationConfig_EventType) Number

func (NotificationConfig_EventType) String

func (NotificationConfig_EventType) Type

NotificationConfig_PayloadFormat

type NotificationConfig_PayloadFormat int32

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

NotificationConfig_PAYLOAD_FORMAT_UNSPECIFIED, NotificationConfig_NONE, NotificationConfig_JSON

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) Enum

func (NotificationConfig_PayloadFormat) EnumDescriptor

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

Deprecated: Use NotificationConfig_PayloadFormat.Descriptor instead.

func (NotificationConfig_PayloadFormat) Number

func (NotificationConfig_PayloadFormat) String

func (NotificationConfig_PayloadFormat) Type

ObjectConditions

type ObjectConditions struct {
	MinTimeElapsedSinceLastModification *duration.Duration "" /* 174 byte string literal not displayed */

	MaxTimeElapsedSinceLastModification *duration.Duration "" /* 174 byte string literal not displayed */

	IncludePrefixes []string `protobuf:"bytes,3,rep,name=include_prefixes,json=includePrefixes,proto3" json:"include_prefixes,omitempty"`

	ExcludePrefixes []string `protobuf:"bytes,4,rep,name=exclude_prefixes,json=excludePrefixes,proto3" json:"exclude_prefixes,omitempty"`

	LastModifiedSince *timestamp.Timestamp `protobuf:"bytes,5,opt,name=last_modified_since,json=lastModifiedSince,proto3" json:"last_modified_since,omitempty"`

	LastModifiedBefore *timestamp.Timestamp `protobuf:"bytes,6,opt,name=last_modified_before,json=lastModifiedBefore,proto3" json:"last_modified_before,omitempty"`

}

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

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() *timestamp.Timestamp

func (*ObjectConditions) GetLastModifiedSince

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

func (*ObjectConditions) GetMaxTimeElapsedSinceLastModification

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

func (*ObjectConditions) GetMinTimeElapsedSinceLastModification

func (x *ObjectConditions) GetMinTimeElapsedSinceLastModification() *duration.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

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

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

Deprecated: Use PauseTransferOperationRequest.ProtoReflect.Descriptor instead.

func (*PauseTransferOperationRequest) GetName

func (*PauseTransferOperationRequest) ProtoMessage

func (*PauseTransferOperationRequest) ProtoMessage()

func (*PauseTransferOperationRequest) ProtoReflect

func (*PauseTransferOperationRequest) Reset

func (x *PauseTransferOperationRequest) Reset()

func (*PauseTransferOperationRequest) String

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

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

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

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

Deprecated: Use ResumeTransferOperationRequest.ProtoReflect.Descriptor instead.

func (*ResumeTransferOperationRequest) GetName

func (*ResumeTransferOperationRequest) ProtoMessage

func (*ResumeTransferOperationRequest) ProtoMessage()

func (*ResumeTransferOperationRequest) ProtoReflect

func (*ResumeTransferOperationRequest) Reset

func (x *ResumeTransferOperationRequest) Reset()

func (*ResumeTransferOperationRequest) String

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

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

S3CompatibleMetadata

type S3CompatibleMetadata struct {
	AuthMethod S3CompatibleMetadata_AuthMethod "" /* 155 byte string literal not displayed */

	RequestModel S3CompatibleMetadata_RequestModel "" /* 163 byte string literal not displayed */

	Protocol S3CompatibleMetadata_NetworkProtocol "" /* 138 byte string literal not displayed */

	ListApi S3CompatibleMetadata_ListApi "" /* 143 byte string literal not displayed */

}

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

func (*S3CompatibleMetadata) Descriptor

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

Deprecated: Use S3CompatibleMetadata.ProtoReflect.Descriptor instead.

func (*S3CompatibleMetadata) GetAuthMethod

func (*S3CompatibleMetadata) GetListApi

func (*S3CompatibleMetadata) GetProtocol

func (*S3CompatibleMetadata) GetRequestModel

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

S3CompatibleMetadata_AuthMethod

type S3CompatibleMetadata_AuthMethod int32

The authentication and authorization method used by the storage service.

S3CompatibleMetadata_AUTH_METHOD_UNSPECIFIED, S3CompatibleMetadata_AUTH_METHOD_AWS_SIGNATURE_V4, S3CompatibleMetadata_AUTH_METHOD_AWS_SIGNATURE_V2

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) Enum

func (S3CompatibleMetadata_AuthMethod) EnumDescriptor

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

Deprecated: Use S3CompatibleMetadata_AuthMethod.Descriptor instead.

func (S3CompatibleMetadata_AuthMethod) Number

func (S3CompatibleMetadata_AuthMethod) String

func (S3CompatibleMetadata_AuthMethod) Type

S3CompatibleMetadata_ListApi

type S3CompatibleMetadata_ListApi int32

The Listing API to use for discovering objects.

S3CompatibleMetadata_LIST_API_UNSPECIFIED, S3CompatibleMetadata_LIST_OBJECTS_V2, S3CompatibleMetadata_LIST_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) Enum

func (S3CompatibleMetadata_ListApi) EnumDescriptor

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

Deprecated: Use S3CompatibleMetadata_ListApi.Descriptor instead.

func (S3CompatibleMetadata_ListApi) Number

func (S3CompatibleMetadata_ListApi) String

func (S3CompatibleMetadata_ListApi) Type

S3CompatibleMetadata_NetworkProtocol

type S3CompatibleMetadata_NetworkProtocol int32

The agent network protocol to access the storage service.

S3CompatibleMetadata_NETWORK_PROTOCOL_UNSPECIFIED, S3CompatibleMetadata_NETWORK_PROTOCOL_HTTPS, S3CompatibleMetadata_NETWORK_PROTOCOL_HTTP

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) Enum

func (S3CompatibleMetadata_NetworkProtocol) EnumDescriptor

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

Deprecated: Use S3CompatibleMetadata_NetworkProtocol.Descriptor instead.

func (S3CompatibleMetadata_NetworkProtocol) Number

func (S3CompatibleMetadata_NetworkProtocol) String

func (S3CompatibleMetadata_NetworkProtocol) Type

S3CompatibleMetadata_RequestModel

type S3CompatibleMetadata_RequestModel int32

The request model of the API.

S3CompatibleMetadata_REQUEST_MODEL_UNSPECIFIED, S3CompatibleMetadata_REQUEST_MODEL_VIRTUAL_HOSTED_STYLE, S3CompatibleMetadata_REQUEST_MODEL_PATH_STYLE

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) Enum

func (S3CompatibleMetadata_RequestModel) EnumDescriptor

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

Deprecated: Use S3CompatibleMetadata_RequestModel.Descriptor instead.

func (S3CompatibleMetadata_RequestModel) Number

func (S3CompatibleMetadata_RequestModel) String

func (S3CompatibleMetadata_RequestModel) 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 *duration.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

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() *duration.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

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) (*empty.Empty, error)
	// Resumes a transfer operation that is paused.
	ResumeTransferOperation(ctx context.Context, in *ResumeTransferOperationRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	// Attempts to start a new TransferOperation for the current TransferJob. A
	// TransferJob has a maximum of one active TransferOperation. If this method
	// is called while a TransferOperation is active, an error will be returned.
	RunTransferJob(ctx context.Context, in *RunTransferJobRequest, opts ...grpc.CallOption) (*longrunning.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) (*empty.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) (*empty.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

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) (*empty.Empty, error)
	// Resumes a transfer operation that is paused.
	ResumeTransferOperation(context.Context, *ResumeTransferOperationRequest) (*empty.Empty, error)
	// Attempts to start a new TransferOperation for the current TransferJob. A
	// TransferJob has a maximum of one active TransferOperation. If this method
	// is called while a TransferOperation is active, an error will be returned.
	RunTransferJob(context.Context, *RunTransferJobRequest) (*longrunning.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) (*empty.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) (*empty.Empty, error)
}

StorageTransferServiceServer is the server API for StorageTransferService service.

TransferCounters

type TransferCounters struct {
	ObjectsFoundFromSource int64 "" /* 132 byte string literal not displayed */

	BytesFoundFromSource int64 `protobuf:"varint,2,opt,name=bytes_found_from_source,json=bytesFoundFromSource,proto3" json:"bytes_found_from_source,omitempty"`

	ObjectsFoundOnlyFromSink int64 "" /* 140 byte string literal not displayed */

	BytesFoundOnlyFromSink int64 "" /* 134 byte string literal not displayed */

	ObjectsFromSourceSkippedBySync int64 "" /* 160 byte string literal not displayed */

	BytesFromSourceSkippedBySync int64 "" /* 154 byte string literal not displayed */

	ObjectsCopiedToSink int64 `protobuf:"varint,7,opt,name=objects_copied_to_sink,json=objectsCopiedToSink,proto3" json:"objects_copied_to_sink,omitempty"`

	BytesCopiedToSink int64 `protobuf:"varint,8,opt,name=bytes_copied_to_sink,json=bytesCopiedToSink,proto3" json:"bytes_copied_to_sink,omitempty"`

	ObjectsDeletedFromSource int64 "" /* 138 byte string literal not displayed */

	BytesDeletedFromSource int64 "" /* 133 byte string literal not displayed */

	ObjectsDeletedFromSink int64 "" /* 133 byte string literal not displayed */

	BytesDeletedFromSink int64 "" /* 127 byte string literal not displayed */

	ObjectsFromSourceFailed int64 "" /* 136 byte string literal not displayed */

	BytesFromSourceFailed int64 "" /* 130 byte string literal not displayed */

	ObjectsFailedToDeleteFromSink int64 "" /* 158 byte string literal not displayed */

	BytesFailedToDeleteFromSink int64 "" /* 152 byte string literal not displayed */

	DirectoriesFoundFromSource int64 "" /* 145 byte string literal not displayed */

	DirectoriesFailedToListFromSource int64 "" /* 170 byte string literal not displayed */

	DirectoriesSuccessfullyListedFromSource int64 "" /* 186 byte string literal not displayed */

	IntermediateObjectsCleanedUp int64 "" /* 151 byte string literal not displayed */

	IntermediateObjectsFailedCleanedUp int64 "" /* 171 byte string literal not displayed */

}

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

func (*TransferCounters) Descriptor

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

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"`
	// 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 *timestamp.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 *timestamp.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 *timestamp.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

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

Deprecated: Use TransferJob.ProtoReflect.Descriptor instead.

func (*TransferJob) GetCreationTime

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

func (*TransferJob) GetDeletionTime

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

func (*TransferJob) GetDescription

func (x *TransferJob) GetDescription() string

func (*TransferJob) GetLastModificationTime

func (x *TransferJob) GetLastModificationTime() *timestamp.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

TransferJob_Status

type TransferJob_Status int32

The status of the transfer job.

TransferJob_STATUS_UNSPECIFIED, TransferJob_ENABLED, TransferJob_DISABLED, TransferJob_DELETED

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) Enum

func (TransferJob_Status) EnumDescriptor

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

Deprecated: Use TransferJob_Status.Descriptor instead.

func (TransferJob_Status) Number

func (TransferJob_Status) String

func (x TransferJob_Status) String() string

func (TransferJob_Status) 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

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

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"`
	// Start time of this transfer execution.
	StartTime *timestamp.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// End time of this transfer execution.
	EndTime *timestamp.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

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() *timestamp.Timestamp

func (*TransferOperation) GetErrorBreakdowns

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

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() *timestamp.Timestamp

func (*TransferOperation) GetStatus

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

TransferOperation_Status

type TransferOperation_Status int32

The status of a TransferOperation.

TransferOperation_STATUS_UNSPECIFIED, TransferOperation_IN_PROGRESS, TransferOperation_PAUSED, TransferOperation_SUCCESS, TransferOperation_FAILED, TransferOperation_ABORTED, TransferOperation_QUEUED

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
)

func (TransferOperation_Status) Descriptor

func (TransferOperation_Status) Enum

func (TransferOperation_Status) EnumDescriptor

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

Deprecated: Use TransferOperation_Status.Descriptor instead.

func (TransferOperation_Status) Number

func (TransferOperation_Status) String

func (x TransferOperation_Status) String() string

func (TransferOperation_Status) Type

TransferOptions

type TransferOptions struct {
	OverwriteObjectsAlreadyExistingInSink bool "" /* 181 byte string literal not displayed */

	DeleteObjectsUniqueInSink bool "" /* 143 byte string literal not displayed */

	DeleteObjectsFromSourceAfterTransfer bool "" /* 178 byte string literal not displayed */

	OverwriteWhen TransferOptions_OverwriteWhen "" /* 162 byte string literal not displayed */

	MetadataOptions *MetadataOptions `protobuf:"bytes,5,opt,name=metadata_options,json=metadataOptions,proto3" json:"metadata_options,omitempty"`

}

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

func (*TransferOptions) Descriptor

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

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.

TransferOptions_OVERWRITE_WHEN_UNSPECIFIED, TransferOptions_DIFFERENT, TransferOptions_NEVER, TransferOptions_ALWAYS

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) Enum

func (TransferOptions_OverwriteWhen) EnumDescriptor

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

Deprecated: Use TransferOptions_OverwriteWhen.Descriptor instead.

func (TransferOptions_OverwriteWhen) Number

func (TransferOptions_OverwriteWhen) String

func (TransferOptions_OverwriteWhen) 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"`
	// Represents a supported data container type which is required for transfer
	// jobs which needs a data source, a data sink and an intermediate location to
	// transfer data through. This is validated on TransferJob creation.
	//
	// 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

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

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"`
}

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"`
}

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"`
}

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"`
}

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"`
}

TransferSpec_GcsIntermediateDataLocation

type TransferSpec_GcsIntermediateDataLocation struct {
	// Cloud Storage intermediate data location.
	GcsIntermediateDataLocation *GcsData `protobuf:"bytes,16,opt,name=gcs_intermediate_data_location,json=gcsIntermediateDataLocation,proto3,oneof"`
}

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"`
}

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"`
}

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"`
}

UnimplementedStorageTransferServiceServer

type UnimplementedStorageTransferServiceServer struct {
}

UnimplementedStorageTransferServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedStorageTransferServiceServer) CreateAgentPool

func (*UnimplementedStorageTransferServiceServer) CreateTransferJob

func (*UnimplementedStorageTransferServiceServer) DeleteAgentPool

func (*UnimplementedStorageTransferServiceServer) DeleteTransferJob

func (*UnimplementedStorageTransferServiceServer) GetAgentPool

func (*UnimplementedStorageTransferServiceServer) GetGoogleServiceAccount

func (*UnimplementedStorageTransferServiceServer) GetTransferJob

func (*UnimplementedStorageTransferServiceServer) ListAgentPools

func (*UnimplementedStorageTransferServiceServer) ListTransferJobs

func (*UnimplementedStorageTransferServiceServer) PauseTransferOperation

func (*UnimplementedStorageTransferServiceServer) ResumeTransferOperation

func (*UnimplementedStorageTransferServiceServer) RunTransferJob

func (*UnimplementedStorageTransferServiceServer) UpdateAgentPool

func (*UnimplementedStorageTransferServiceServer) UpdateTransferJob

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 *field_mask.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

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() *field_mask.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

UpdateTransferJobRequest

type UpdateTransferJobRequest struct {
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`

	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`

	TransferJob *TransferJob `protobuf:"bytes,3,opt,name=transfer_job,json=transferJob,proto3" json:"transfer_job,omitempty"`

	UpdateTransferJobFieldMask *field_mask.FieldMask "" /* 145 byte string literal not displayed */

}

Request passed to UpdateTransferJob.

func (*UpdateTransferJobRequest) Descriptor

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() *field_mask.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