storagetransfer

package
v0.0.0-...-5fc9ac5 Latest Latest
Warning

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

Go to latest
Published: Nov 7, 2018 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var TransferJob_Status_name = map[int32]string{
	0: "STATUS_UNSPECIFIED",
	1: "ENABLED",
	2: "DISABLED",
	3: "DELETED",
}
View Source
var TransferJob_Status_value = map[string]int32{
	"STATUS_UNSPECIFIED": 0,
	"ENABLED":            1,
	"DISABLED":           2,
	"DELETED":            3,
}
View Source
var TransferOperation_Status_name = map[int32]string{
	0: "STATUS_UNSPECIFIED",
	1: "IN_PROGRESS",
	2: "PAUSED",
	3: "SUCCESS",
	4: "FAILED",
	5: "ABORTED",
}
View Source
var TransferOperation_Status_value = map[string]int32{
	"STATUS_UNSPECIFIED": 0,
	"IN_PROGRESS":        1,
	"PAUSED":             2,
	"SUCCESS":            3,
	"FAILED":             4,
	"ABORTED":            5,
}

Functions

func RegisterStorageTransferServiceServer

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

Types

type AwsAccessKey

type AwsAccessKey struct {
	// AWS access key ID.
	// Required.
	AccessKeyId string `protobuf:"bytes,1,opt,name=access_key_id,json=accessKeyId,proto3" json:"access_key_id,omitempty"`
	// AWS secret access key. This field is not returned in RPC responses.
	// Required.
	SecretAccessKey      string   `protobuf:"bytes,2,opt,name=secret_access_key,json=secretAccessKey,proto3" json:"secret_access_key,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*AwsAccessKey) Descriptor

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

func (*AwsAccessKey) GetAccessKeyId

func (m *AwsAccessKey) GetAccessKeyId() string

func (*AwsAccessKey) GetSecretAccessKey

func (m *AwsAccessKey) GetSecretAccessKey() string

func (*AwsAccessKey) ProtoMessage

func (*AwsAccessKey) ProtoMessage()

func (*AwsAccessKey) Reset

func (m *AwsAccessKey) Reset()

func (*AwsAccessKey) String

func (m *AwsAccessKey) String() string

func (*AwsAccessKey) XXX_DiscardUnknown

func (m *AwsAccessKey) XXX_DiscardUnknown()

func (*AwsAccessKey) XXX_Marshal

func (m *AwsAccessKey) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AwsAccessKey) XXX_Merge

func (m *AwsAccessKey) XXX_Merge(src proto.Message)

func (*AwsAccessKey) XXX_Size

func (m *AwsAccessKey) XXX_Size() int

func (*AwsAccessKey) XXX_Unmarshal

func (m *AwsAccessKey) XXX_Unmarshal(b []byte) error

type AwsS3Data

type AwsS3Data struct {
	// S3 Bucket name (see
	// [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).
	// Required.
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// 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.
	// Required.
	AwsAccessKey         *AwsAccessKey `protobuf:"bytes,2,opt,name=aws_access_key,json=awsAccessKey,proto3" json:"aws_access_key,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an object's name is the S3 object's key name.

func (*AwsS3Data) Descriptor

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

func (*AwsS3Data) GetAwsAccessKey

func (m *AwsS3Data) GetAwsAccessKey() *AwsAccessKey

func (*AwsS3Data) GetBucketName

func (m *AwsS3Data) GetBucketName() string

func (*AwsS3Data) ProtoMessage

func (*AwsS3Data) ProtoMessage()

func (*AwsS3Data) Reset

func (m *AwsS3Data) Reset()

func (*AwsS3Data) String

func (m *AwsS3Data) String() string

func (*AwsS3Data) XXX_DiscardUnknown

func (m *AwsS3Data) XXX_DiscardUnknown()

func (*AwsS3Data) XXX_Marshal

func (m *AwsS3Data) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AwsS3Data) XXX_Merge

func (m *AwsS3Data) XXX_Merge(src proto.Message)

func (*AwsS3Data) XXX_Size

func (m *AwsS3Data) XXX_Size() int

func (*AwsS3Data) XXX_Unmarshal

func (m *AwsS3Data) XXX_Unmarshal(b []byte) error

type CreateTransferJobRequest

type CreateTransferJobRequest struct {
	// The job to create.
	// Required.
	TransferJob          *TransferJob `protobuf:"bytes,1,opt,name=transfer_job,json=transferJob,proto3" json:"transfer_job,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

Request passed to CreateTransferJob.

func (*CreateTransferJobRequest) Descriptor

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

func (*CreateTransferJobRequest) GetTransferJob

func (m *CreateTransferJobRequest) GetTransferJob() *TransferJob

func (*CreateTransferJobRequest) ProtoMessage

func (*CreateTransferJobRequest) ProtoMessage()

func (*CreateTransferJobRequest) Reset

func (m *CreateTransferJobRequest) Reset()

func (*CreateTransferJobRequest) String

func (m *CreateTransferJobRequest) String() string

func (*CreateTransferJobRequest) XXX_DiscardUnknown

func (m *CreateTransferJobRequest) XXX_DiscardUnknown()

func (*CreateTransferJobRequest) XXX_Marshal

func (m *CreateTransferJobRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateTransferJobRequest) XXX_Merge

func (m *CreateTransferJobRequest) XXX_Merge(src proto.Message)

func (*CreateTransferJobRequest) XXX_Size

func (m *CreateTransferJobRequest) XXX_Size() int

func (*CreateTransferJobRequest) XXX_Unmarshal

func (m *CreateTransferJobRequest) XXX_Unmarshal(b []byte) error

type ErrorLogEntry

type ErrorLogEntry struct {
	// A URL that refers to the target (a data source, a data sink,
	// or an object) with which the error is associated.
	// Required.
	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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

An entry describing an error that has occurred.

func (*ErrorLogEntry) Descriptor

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

func (*ErrorLogEntry) GetErrorDetails

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

func (*ErrorLogEntry) GetUrl

func (m *ErrorLogEntry) GetUrl() string

func (*ErrorLogEntry) ProtoMessage

func (*ErrorLogEntry) ProtoMessage()

func (*ErrorLogEntry) Reset

func (m *ErrorLogEntry) Reset()

func (*ErrorLogEntry) String

func (m *ErrorLogEntry) String() string

func (*ErrorLogEntry) XXX_DiscardUnknown

func (m *ErrorLogEntry) XXX_DiscardUnknown()

func (*ErrorLogEntry) XXX_Marshal

func (m *ErrorLogEntry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ErrorLogEntry) XXX_Merge

func (m *ErrorLogEntry) XXX_Merge(src proto.Message)

func (*ErrorLogEntry) XXX_Size

func (m *ErrorLogEntry) XXX_Size() int

func (*ErrorLogEntry) XXX_Unmarshal

func (m *ErrorLogEntry) XXX_Unmarshal(b []byte) error

type ErrorSummary

type ErrorSummary struct {
	// Required.
	ErrorCode code.Code `protobuf:"varint,1,opt,name=error_code,json=errorCode,proto3,enum=google.rpc.Code" json:"error_code,omitempty"`
	// Count of this type of error.
	// Required.
	ErrorCount int64 `protobuf:"varint,2,opt,name=error_count,json=errorCount,proto3" json:"error_count,omitempty"`
	// Error samples.
	ErrorLogEntries      []*ErrorLogEntry `protobuf:"bytes,3,rep,name=error_log_entries,json=errorLogEntries,proto3" json:"error_log_entries,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

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

func (*ErrorSummary) Descriptor

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

func (*ErrorSummary) GetErrorCode

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

func (*ErrorSummary) GetErrorCount

func (m *ErrorSummary) GetErrorCount() int64

func (*ErrorSummary) GetErrorLogEntries

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

func (*ErrorSummary) ProtoMessage

func (*ErrorSummary) ProtoMessage()

func (*ErrorSummary) Reset

func (m *ErrorSummary) Reset()

func (*ErrorSummary) String

func (m *ErrorSummary) String() string

func (*ErrorSummary) XXX_DiscardUnknown

func (m *ErrorSummary) XXX_DiscardUnknown()

func (*ErrorSummary) XXX_Marshal

func (m *ErrorSummary) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ErrorSummary) XXX_Merge

func (m *ErrorSummary) XXX_Merge(src proto.Message)

func (*ErrorSummary) XXX_Size

func (m *ErrorSummary) XXX_Size() int

func (*ErrorSummary) XXX_Unmarshal

func (m *ErrorSummary) XXX_Unmarshal(b []byte) error

type GcsData

type GcsData struct {
	// Google Cloud Storage bucket name (see
	// [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
	// Required.
	BucketName           string   `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

In a GcsData, an object's name is the Google Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated.

func (*GcsData) Descriptor

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

func (*GcsData) GetBucketName

func (m *GcsData) GetBucketName() string

func (*GcsData) ProtoMessage

func (*GcsData) ProtoMessage()

func (*GcsData) Reset

func (m *GcsData) Reset()

func (*GcsData) String

func (m *GcsData) String() string

func (*GcsData) XXX_DiscardUnknown

func (m *GcsData) XXX_DiscardUnknown()

func (*GcsData) XXX_Marshal

func (m *GcsData) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GcsData) XXX_Merge

func (m *GcsData) XXX_Merge(src proto.Message)

func (*GcsData) XXX_Size

func (m *GcsData) XXX_Size() int

func (*GcsData) XXX_Unmarshal

func (m *GcsData) XXX_Unmarshal(b []byte) error

type GetGoogleServiceAccountRequest

type GetGoogleServiceAccountRequest struct {
	// The ID of the Google Cloud Platform Console project that the Google service
	// account is associated with.
	// Required.
	ProjectId            string   `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request passed to GetGoogleServiceAccount.

func (*GetGoogleServiceAccountRequest) Descriptor

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

func (*GetGoogleServiceAccountRequest) GetProjectId

func (m *GetGoogleServiceAccountRequest) GetProjectId() string

func (*GetGoogleServiceAccountRequest) ProtoMessage

func (*GetGoogleServiceAccountRequest) ProtoMessage()

func (*GetGoogleServiceAccountRequest) Reset

func (m *GetGoogleServiceAccountRequest) Reset()

func (*GetGoogleServiceAccountRequest) String

func (*GetGoogleServiceAccountRequest) XXX_DiscardUnknown

func (m *GetGoogleServiceAccountRequest) XXX_DiscardUnknown()

func (*GetGoogleServiceAccountRequest) XXX_Marshal

func (m *GetGoogleServiceAccountRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetGoogleServiceAccountRequest) XXX_Merge

func (m *GetGoogleServiceAccountRequest) XXX_Merge(src proto.Message)

func (*GetGoogleServiceAccountRequest) XXX_Size

func (m *GetGoogleServiceAccountRequest) XXX_Size() int

func (*GetGoogleServiceAccountRequest) XXX_Unmarshal

func (m *GetGoogleServiceAccountRequest) XXX_Unmarshal(b []byte) error

type GetTransferJobRequest

type GetTransferJobRequest struct {
	// The job to get.
	// Required.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// The ID of the Google Cloud Platform Console project that owns the job.
	// Required.
	ProjectId            string   `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request passed to GetTransferJob.

func (*GetTransferJobRequest) Descriptor

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

func (*GetTransferJobRequest) GetJobName

func (m *GetTransferJobRequest) GetJobName() string

func (*GetTransferJobRequest) GetProjectId

func (m *GetTransferJobRequest) GetProjectId() string

func (*GetTransferJobRequest) ProtoMessage

func (*GetTransferJobRequest) ProtoMessage()

func (*GetTransferJobRequest) Reset

func (m *GetTransferJobRequest) Reset()

func (*GetTransferJobRequest) String

func (m *GetTransferJobRequest) String() string

func (*GetTransferJobRequest) XXX_DiscardUnknown

func (m *GetTransferJobRequest) XXX_DiscardUnknown()

func (*GetTransferJobRequest) XXX_Marshal

func (m *GetTransferJobRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetTransferJobRequest) XXX_Merge

func (m *GetTransferJobRequest) XXX_Merge(src proto.Message)

func (*GetTransferJobRequest) XXX_Size

func (m *GetTransferJobRequest) XXX_Size() int

func (*GetTransferJobRequest) XXX_Unmarshal

func (m *GetTransferJobRequest) XXX_Unmarshal(b []byte) error

type GoogleServiceAccount

type GoogleServiceAccount struct {
	// Required.
	AccountEmail         string   `protobuf:"bytes,1,opt,name=account_email,json=accountEmail,proto3" json:"account_email,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Google service account

func (*GoogleServiceAccount) Descriptor

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

func (*GoogleServiceAccount) GetAccountEmail

func (m *GoogleServiceAccount) GetAccountEmail() string

func (*GoogleServiceAccount) ProtoMessage

func (*GoogleServiceAccount) ProtoMessage()

func (*GoogleServiceAccount) Reset

func (m *GoogleServiceAccount) Reset()

func (*GoogleServiceAccount) String

func (m *GoogleServiceAccount) String() string

func (*GoogleServiceAccount) XXX_DiscardUnknown

func (m *GoogleServiceAccount) XXX_DiscardUnknown()

func (*GoogleServiceAccount) XXX_Marshal

func (m *GoogleServiceAccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GoogleServiceAccount) XXX_Merge

func (m *GoogleServiceAccount) XXX_Merge(src proto.Message)

func (*GoogleServiceAccount) XXX_Size

func (m *GoogleServiceAccount) XXX_Size() int

func (*GoogleServiceAccount) XXX_Unmarshal

func (m *GoogleServiceAccount) XXX_Unmarshal(b []byte) error

type HttpData

type HttpData struct {
	// 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.
	// Required.
	ListUrl              string   `protobuf:"bytes,1,opt,name=list_url,json=listUrl,proto3" json:"list_url,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

An HttpData specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields:

* HTTP URL - The location of the object.

* Length - The size of the object in bytes.

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

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

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

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

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

* If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. For more information, see [Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5)

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

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

* ObjectConditions(#ObjectConditions) have no effect when filtering objects to transfer.

func (*HttpData) Descriptor

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

func (*HttpData) GetListUrl

func (m *HttpData) GetListUrl() string

func (*HttpData) ProtoMessage

func (*HttpData) ProtoMessage()

func (*HttpData) Reset

func (m *HttpData) Reset()

func (*HttpData) String

func (m *HttpData) String() string

func (*HttpData) XXX_DiscardUnknown

func (m *HttpData) XXX_DiscardUnknown()

func (*HttpData) XXX_Marshal

func (m *HttpData) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HttpData) XXX_Merge

func (m *HttpData) XXX_Merge(src proto.Message)

func (*HttpData) XXX_Size

func (m *HttpData) XXX_Size() int

func (*HttpData) XXX_Unmarshal

func (m *HttpData) XXX_Unmarshal(b []byte) error

type ListTransferJobsRequest

type ListTransferJobsRequest struct {
	// A list of query parameters specified as JSON text in the form of
	// {"project_id":"my_project_id",
	// "job_names":["jobid1","jobid2",...],
	// "job_statuses":["status1","status2",...]}.
	// Since `job_names` and `job_statuses` support multiple values, their values
	// must be specified with array notation. `project_id` is required. `job_names`
	// and `job_statuses` are optional.  The valid values for `job_statuses` are
	// case-insensitive: `ENABLED`, `DISABLED`, and `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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

`project_id`, `job_names`, and `job_statuses` are query parameters that can be specified when listing transfer jobs.

func (*ListTransferJobsRequest) Descriptor

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

func (*ListTransferJobsRequest) GetFilter

func (m *ListTransferJobsRequest) GetFilter() string

func (*ListTransferJobsRequest) GetPageSize

func (m *ListTransferJobsRequest) GetPageSize() int32

func (*ListTransferJobsRequest) GetPageToken

func (m *ListTransferJobsRequest) GetPageToken() string

func (*ListTransferJobsRequest) ProtoMessage

func (*ListTransferJobsRequest) ProtoMessage()

func (*ListTransferJobsRequest) Reset

func (m *ListTransferJobsRequest) Reset()

func (*ListTransferJobsRequest) String

func (m *ListTransferJobsRequest) String() string

func (*ListTransferJobsRequest) XXX_DiscardUnknown

func (m *ListTransferJobsRequest) XXX_DiscardUnknown()

func (*ListTransferJobsRequest) XXX_Marshal

func (m *ListTransferJobsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListTransferJobsRequest) XXX_Merge

func (m *ListTransferJobsRequest) XXX_Merge(src proto.Message)

func (*ListTransferJobsRequest) XXX_Size

func (m *ListTransferJobsRequest) XXX_Size() int

func (*ListTransferJobsRequest) XXX_Unmarshal

func (m *ListTransferJobsRequest) XXX_Unmarshal(b []byte) error

type ListTransferJobsResponse

type ListTransferJobsResponse struct {
	// A list of transfer jobs.
	TransferJobs []*TransferJob `protobuf:"bytes,1,rep,name=transfer_jobs,json=transferJobs,proto3" json:"transfer_jobs,omitempty"`
	// The list next page token.
	NextPageToken        string   `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Response from ListTransferJobs.

func (*ListTransferJobsResponse) Descriptor

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

func (*ListTransferJobsResponse) GetNextPageToken

func (m *ListTransferJobsResponse) GetNextPageToken() string

func (*ListTransferJobsResponse) GetTransferJobs

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

func (*ListTransferJobsResponse) ProtoMessage

func (*ListTransferJobsResponse) ProtoMessage()

func (*ListTransferJobsResponse) Reset

func (m *ListTransferJobsResponse) Reset()

func (*ListTransferJobsResponse) String

func (m *ListTransferJobsResponse) String() string

func (*ListTransferJobsResponse) XXX_DiscardUnknown

func (m *ListTransferJobsResponse) XXX_DiscardUnknown()

func (*ListTransferJobsResponse) XXX_Marshal

func (m *ListTransferJobsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListTransferJobsResponse) XXX_Merge

func (m *ListTransferJobsResponse) XXX_Merge(src proto.Message)

func (*ListTransferJobsResponse) XXX_Size

func (m *ListTransferJobsResponse) XXX_Size() int

func (*ListTransferJobsResponse) XXX_Unmarshal

func (m *ListTransferJobsResponse) XXX_Unmarshal(b []byte) error

type ObjectConditions

type ObjectConditions struct {
	// If unspecified, `minTimeElapsedSinceLastModification` takes a zero value
	// and `maxTimeElapsedSinceLastModification` takes the maximum possible
	// value of Duration. Objects that satisfy the object conditions
	// must either have a `lastModificationTime` greater or equal to
	// `NOW` - `maxTimeElapsedSinceLastModification` and less than
	// `NOW` - `minTimeElapsedSinceLastModification`, or not have a
	// `lastModificationTime`.
	MinTimeElapsedSinceLastModification *duration.Duration `` /* 174-byte string literal not displayed */
	// `maxTimeElapsedSinceLastModification` is the complement to
	// `minTimeElapsedSinceLastModification`.
	MaxTimeElapsedSinceLastModification *duration.Duration `` /* 174-byte string literal not displayed */
	// If `includePrefixes` is specified, objects that satisfy the object
	// conditions must have names that start with one of the `includePrefixes`
	// and that do not start with any of the `excludePrefixes`. If `includePrefixes`
	// is not specified, all objects except those that have names starting with
	// one of the `excludePrefixes` must satisfy the object conditions.
	//
	// Requirements:
	//
	//   * Each include-prefix and exclude-prefix can contain any sequence of
	//     Unicode characters, of max length 1024 bytes when UTF8-encoded, and
	//     must not contain Carriage Return or Line Feed characters.  Wildcard
	//     matching and regular expression matching are not supported.
	//
	//   * Each include-prefix and exclude-prefix must omit the leading slash.
	//     For example, to include the `requests.gz` object in a transfer from
	//     `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include
	//     prefix as `logs/y=2015/requests.gz`.
	//
	//   * None of the include-prefix or the exclude-prefix values can be empty,
	//     if specified.
	//
	//   * Each include-prefix must include a distinct portion of the object
	//     namespace, i.e., no include-prefix may be a prefix of another
	//     include-prefix.
	//
	//   * Each exclude-prefix must exclude a distinct portion of the object
	//     namespace, i.e., no exclude-prefix may be a prefix of another
	//     exclude-prefix.
	//
	//   * If `includePrefixes` is specified, then each exclude-prefix must start
	//     with the value of a path explicitly included by `includePrefixes`.
	//
	// The max size of `includePrefixes` is 1000.
	IncludePrefixes []string `protobuf:"bytes,3,rep,name=include_prefixes,json=includePrefixes,proto3" json:"include_prefixes,omitempty"`
	// `excludePrefixes` must follow the requirements described for
	// `includePrefixes`.
	//
	// The max size of `excludePrefixes` is 1000.
	ExcludePrefixes      []string `protobuf:"bytes,4,rep,name=exclude_prefixes,json=excludePrefixes,proto3" json:"exclude_prefixes,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Conditions that determine which objects will be transferred.

func (*ObjectConditions) Descriptor

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

func (*ObjectConditions) GetExcludePrefixes

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

func (*ObjectConditions) GetIncludePrefixes

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

func (*ObjectConditions) GetMaxTimeElapsedSinceLastModification

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

func (*ObjectConditions) GetMinTimeElapsedSinceLastModification

func (m *ObjectConditions) GetMinTimeElapsedSinceLastModification() *duration.Duration

func (*ObjectConditions) ProtoMessage

func (*ObjectConditions) ProtoMessage()

func (*ObjectConditions) Reset

func (m *ObjectConditions) Reset()

func (*ObjectConditions) String

func (m *ObjectConditions) String() string

func (*ObjectConditions) XXX_DiscardUnknown

func (m *ObjectConditions) XXX_DiscardUnknown()

func (*ObjectConditions) XXX_Marshal

func (m *ObjectConditions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ObjectConditions) XXX_Merge

func (m *ObjectConditions) XXX_Merge(src proto.Message)

func (*ObjectConditions) XXX_Size

func (m *ObjectConditions) XXX_Size() int

func (*ObjectConditions) XXX_Unmarshal

func (m *ObjectConditions) XXX_Unmarshal(b []byte) error

type PauseTransferOperationRequest

type PauseTransferOperationRequest struct {
	// The name of the transfer operation.
	// Required.
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request passed to PauseTransferOperation.

func (*PauseTransferOperationRequest) Descriptor

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

func (*PauseTransferOperationRequest) GetName

func (*PauseTransferOperationRequest) ProtoMessage

func (*PauseTransferOperationRequest) ProtoMessage()

func (*PauseTransferOperationRequest) Reset

func (m *PauseTransferOperationRequest) Reset()

func (*PauseTransferOperationRequest) String

func (*PauseTransferOperationRequest) XXX_DiscardUnknown

func (m *PauseTransferOperationRequest) XXX_DiscardUnknown()

func (*PauseTransferOperationRequest) XXX_Marshal

func (m *PauseTransferOperationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PauseTransferOperationRequest) XXX_Merge

func (m *PauseTransferOperationRequest) XXX_Merge(src proto.Message)

func (*PauseTransferOperationRequest) XXX_Size

func (m *PauseTransferOperationRequest) XXX_Size() int

func (*PauseTransferOperationRequest) XXX_Unmarshal

func (m *PauseTransferOperationRequest) XXX_Unmarshal(b []byte) error

type ResumeTransferOperationRequest

type ResumeTransferOperationRequest struct {
	// The name of the transfer operation.
	// Required.
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request passed to ResumeTransferOperation.

func (*ResumeTransferOperationRequest) Descriptor

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

func (*ResumeTransferOperationRequest) GetName

func (*ResumeTransferOperationRequest) ProtoMessage

func (*ResumeTransferOperationRequest) ProtoMessage()

func (*ResumeTransferOperationRequest) Reset

func (m *ResumeTransferOperationRequest) Reset()

func (*ResumeTransferOperationRequest) String

func (*ResumeTransferOperationRequest) XXX_DiscardUnknown

func (m *ResumeTransferOperationRequest) XXX_DiscardUnknown()

func (*ResumeTransferOperationRequest) XXX_Marshal

func (m *ResumeTransferOperationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ResumeTransferOperationRequest) XXX_Merge

func (m *ResumeTransferOperationRequest) XXX_Merge(src proto.Message)

func (*ResumeTransferOperationRequest) XXX_Size

func (m *ResumeTransferOperationRequest) XXX_Size() int

func (*ResumeTransferOperationRequest) XXX_Unmarshal

func (m *ResumeTransferOperationRequest) XXX_Unmarshal(b []byte) error

type Schedule

type Schedule struct {
	// The first day the recurring transfer is scheduled to run. If
	// `scheduleStartDate` is in the past, the transfer will run for the first
	// time on the following day.
	// Required.
	ScheduleStartDate *date.Date `protobuf:"bytes,1,opt,name=schedule_start_date,json=scheduleStartDate,proto3" json:"schedule_start_date,omitempty"`
	// The last day the recurring transfer will be run. If `scheduleEndDate`
	// is the same as `scheduleStartDate`, the transfer will be executed only
	// once.
	ScheduleEndDate *date.Date `protobuf:"bytes,2,opt,name=schedule_end_date,json=scheduleEndDate,proto3" json:"schedule_end_date,omitempty"`
	// The time in UTC at which the transfer will be scheduled to start in a day.
	// Transfers may start later than this time. If not specified, recurring and
	// one-time transfers that are scheduled to run today will run immediately;
	// recurring transfers that are scheduled to run on a future date will start
	// at approximately midnight UTC on that date. Note that when configuring a
	// transfer with the Cloud Platform Console, the transfer's start time in a
	// day is specified in your local timezone.
	StartTimeOfDay       *timeofday.TimeOfDay `protobuf:"bytes,3,opt,name=start_time_of_day,json=startTimeOfDay,proto3" json:"start_time_of_day,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

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

func (*Schedule) Descriptor

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

func (*Schedule) GetScheduleEndDate

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

func (*Schedule) GetScheduleStartDate

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

func (*Schedule) GetStartTimeOfDay

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

func (*Schedule) ProtoMessage

func (*Schedule) ProtoMessage()

func (*Schedule) Reset

func (m *Schedule) Reset()

func (*Schedule) String

func (m *Schedule) String() string

func (*Schedule) XXX_DiscardUnknown

func (m *Schedule) XXX_DiscardUnknown()

func (*Schedule) XXX_Marshal

func (m *Schedule) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Schedule) XXX_Merge

func (m *Schedule) XXX_Merge(src proto.Message)

func (*Schedule) XXX_Size

func (m *Schedule) XXX_Size() int

func (*Schedule) XXX_Unmarshal

func (m *Schedule) XXX_Unmarshal(b []byte) error

type StorageTransferServiceClient

type StorageTransferServiceClient interface {
	// Returns the Google service account that is used by Storage Transfer
	// Service to access buckets in the project where transfers
	// run or in other projects. Each Google service account is associated
	// with one Google Cloud Platform Console 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. Updating the scheduling
	// of a job is not allowed.
	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)
}

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.ClientConn) StorageTransferServiceClient

type StorageTransferServiceServer

type StorageTransferServiceServer interface {
	// Returns the Google service account that is used by Storage Transfer
	// Service to access buckets in the project where transfers
	// run or in other projects. Each Google service account is associated
	// with one Google Cloud Platform Console 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. Updating the scheduling
	// of a job is not allowed.
	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)
}

StorageTransferServiceServer is the server API for StorageTransferService service.

type TransferCounters

type TransferCounters struct {
	// Objects found in the data source that are scheduled to be transferred,
	// excluding any that are filtered based on object conditions or skipped due
	// to sync.
	ObjectsFoundFromSource int64 `` /* 132-byte string literal not displayed */
	// Bytes found in the data source that are scheduled to be transferred,
	// excluding any that are filtered based on object conditions or skipped due
	// to sync.
	BytesFoundFromSource int64 `` /* 126-byte string literal not displayed */
	// Objects found only in the data sink that are scheduled to be deleted.
	ObjectsFoundOnlyFromSink int64 `` /* 140-byte string literal not displayed */
	// Bytes found only in the data sink that are scheduled to be deleted.
	BytesFoundOnlyFromSink int64 `` /* 134-byte string literal not displayed */
	// Objects in the data source that are not transferred because they already
	// exist in the data sink.
	ObjectsFromSourceSkippedBySync int64 `` /* 160-byte string literal not displayed */
	// Bytes in the data source that are not transferred because they already
	// exist in the data sink.
	BytesFromSourceSkippedBySync int64 `` /* 154-byte string literal not displayed */
	// Objects that are copied to the data sink.
	ObjectsCopiedToSink int64 `protobuf:"varint,7,opt,name=objects_copied_to_sink,json=objectsCopiedToSink,proto3" json:"objects_copied_to_sink,omitempty"`
	// Bytes that are copied to the data sink.
	BytesCopiedToSink int64 `protobuf:"varint,8,opt,name=bytes_copied_to_sink,json=bytesCopiedToSink,proto3" json:"bytes_copied_to_sink,omitempty"`
	// Objects that are deleted from the data source.
	ObjectsDeletedFromSource int64 `` /* 138-byte string literal not displayed */
	// Bytes that are deleted from the data source.
	BytesDeletedFromSource int64 `` /* 133-byte string literal not displayed */
	// Objects that are deleted from the data sink.
	ObjectsDeletedFromSink int64 `` /* 133-byte string literal not displayed */
	// Bytes that are deleted from the data sink.
	BytesDeletedFromSink int64 `` /* 127-byte string literal not displayed */
	// Objects in the data source that failed during the transfer.
	ObjectsFromSourceFailed int64 `` /* 136-byte string literal not displayed */
	// Bytes in the data source that failed during the transfer.
	BytesFromSourceFailed int64 `` /* 130-byte string literal not displayed */
	// Objects that failed to be deleted from the data sink.
	ObjectsFailedToDeleteFromSink int64 `` /* 158-byte string literal not displayed */
	// Bytes that failed to be deleted from the data sink.
	BytesFailedToDeleteFromSink int64    `` /* 152-byte string literal not displayed */
	XXX_NoUnkeyedLiteral        struct{} `json:"-"`
	XXX_unrecognized            []byte   `json:"-"`
	XXX_sizecache               int32    `json:"-"`
}

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

func (*TransferCounters) Descriptor

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

func (*TransferCounters) GetBytesCopiedToSink

func (m *TransferCounters) GetBytesCopiedToSink() int64

func (*TransferCounters) GetBytesDeletedFromSink

func (m *TransferCounters) GetBytesDeletedFromSink() int64

func (*TransferCounters) GetBytesDeletedFromSource

func (m *TransferCounters) GetBytesDeletedFromSource() int64

func (*TransferCounters) GetBytesFailedToDeleteFromSink

func (m *TransferCounters) GetBytesFailedToDeleteFromSink() int64

func (*TransferCounters) GetBytesFoundFromSource

func (m *TransferCounters) GetBytesFoundFromSource() int64

func (*TransferCounters) GetBytesFoundOnlyFromSink

func (m *TransferCounters) GetBytesFoundOnlyFromSink() int64

func (*TransferCounters) GetBytesFromSourceFailed

func (m *TransferCounters) GetBytesFromSourceFailed() int64

func (*TransferCounters) GetBytesFromSourceSkippedBySync

func (m *TransferCounters) GetBytesFromSourceSkippedBySync() int64

func (*TransferCounters) GetObjectsCopiedToSink

func (m *TransferCounters) GetObjectsCopiedToSink() int64

func (*TransferCounters) GetObjectsDeletedFromSink

func (m *TransferCounters) GetObjectsDeletedFromSink() int64

func (*TransferCounters) GetObjectsDeletedFromSource

func (m *TransferCounters) GetObjectsDeletedFromSource() int64

func (*TransferCounters) GetObjectsFailedToDeleteFromSink

func (m *TransferCounters) GetObjectsFailedToDeleteFromSink() int64

func (*TransferCounters) GetObjectsFoundFromSource

func (m *TransferCounters) GetObjectsFoundFromSource() int64

func (*TransferCounters) GetObjectsFoundOnlyFromSink

func (m *TransferCounters) GetObjectsFoundOnlyFromSink() int64

func (*TransferCounters) GetObjectsFromSourceFailed

func (m *TransferCounters) GetObjectsFromSourceFailed() int64

func (*TransferCounters) GetObjectsFromSourceSkippedBySync

func (m *TransferCounters) GetObjectsFromSourceSkippedBySync() int64

func (*TransferCounters) ProtoMessage

func (*TransferCounters) ProtoMessage()

func (*TransferCounters) Reset

func (m *TransferCounters) Reset()

func (*TransferCounters) String

func (m *TransferCounters) String() string

func (*TransferCounters) XXX_DiscardUnknown

func (m *TransferCounters) XXX_DiscardUnknown()

func (*TransferCounters) XXX_Marshal

func (m *TransferCounters) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TransferCounters) XXX_Merge

func (m *TransferCounters) XXX_Merge(src proto.Message)

func (*TransferCounters) XXX_Size

func (m *TransferCounters) XXX_Size() int

func (*TransferCounters) XXX_Unmarshal

func (m *TransferCounters) XXX_Unmarshal(b []byte) error

type TransferJob

type TransferJob struct {
	// A globally unique name assigned by Storage Transfer Service when the
	// job is created. This field should be left empty in requests to create a new
	// transfer job; otherwise, the requests result in an `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 Platform Console 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"`
	// Schedule specification.
	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` to
	// `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"`
	// This field cannot be changed by user requests.
	CreationTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=creation_time,json=creationTime,proto3" json:"creation_time,omitempty"`
	// This field cannot be changed by user requests.
	LastModificationTime *timestamp.Timestamp `protobuf:"bytes,8,opt,name=last_modification_time,json=lastModificationTime,proto3" json:"last_modification_time,omitempty"`
	// This field cannot be changed by user requests.
	DeletionTime         *timestamp.Timestamp `protobuf:"bytes,9,opt,name=deletion_time,json=deletionTime,proto3" json:"deletion_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

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

func (*TransferJob) Descriptor

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

func (*TransferJob) GetCreationTime

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

func (*TransferJob) GetDeletionTime

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

func (*TransferJob) GetDescription

func (m *TransferJob) GetDescription() string

func (*TransferJob) GetLastModificationTime

func (m *TransferJob) GetLastModificationTime() *timestamp.Timestamp

func (*TransferJob) GetName

func (m *TransferJob) GetName() string

func (*TransferJob) GetProjectId

func (m *TransferJob) GetProjectId() string

func (*TransferJob) GetSchedule

func (m *TransferJob) GetSchedule() *Schedule

func (*TransferJob) GetStatus

func (m *TransferJob) GetStatus() TransferJob_Status

func (*TransferJob) GetTransferSpec

func (m *TransferJob) GetTransferSpec() *TransferSpec

func (*TransferJob) ProtoMessage

func (*TransferJob) ProtoMessage()

func (*TransferJob) Reset

func (m *TransferJob) Reset()

func (*TransferJob) String

func (m *TransferJob) String() string

func (*TransferJob) XXX_DiscardUnknown

func (m *TransferJob) XXX_DiscardUnknown()

func (*TransferJob) XXX_Marshal

func (m *TransferJob) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TransferJob) XXX_Merge

func (m *TransferJob) XXX_Merge(src proto.Message)

func (*TransferJob) XXX_Size

func (m *TransferJob) XXX_Size() int

func (*TransferJob) XXX_Unmarshal

func (m *TransferJob) XXX_Unmarshal(b []byte) error

type TransferJob_Status

type TransferJob_Status int32

The status of the transfer job.

const (
	// Zero is an illegal value.
	TransferJob_STATUS_UNSPECIFIED TransferJob_Status = 0
	// New transfers will be performed based on the schedule.
	TransferJob_ENABLED TransferJob_Status = 1
	// New transfers will not be 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.
	TransferJob_DELETED TransferJob_Status = 3
)

func (TransferJob_Status) EnumDescriptor

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

func (TransferJob_Status) String

func (x TransferJob_Status) String() string

type TransferOperation

type TransferOperation struct {
	// A globally unique ID assigned by the system.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The ID of the Google Cloud Platform Console project that owns the operation.
	// Required.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Transfer specification.
	// Required.
	TransferSpec *TransferSpec `protobuf:"bytes,3,opt,name=transfer_spec,json=transferSpec,proto3" json:"transfer_spec,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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A description of the execution of a transfer.

func (*TransferOperation) Descriptor

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

func (*TransferOperation) GetCounters

func (m *TransferOperation) GetCounters() *TransferCounters

func (*TransferOperation) GetEndTime

func (m *TransferOperation) GetEndTime() *timestamp.Timestamp

func (*TransferOperation) GetErrorBreakdowns

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

func (*TransferOperation) GetName

func (m *TransferOperation) GetName() string

func (*TransferOperation) GetProjectId

func (m *TransferOperation) GetProjectId() string

func (*TransferOperation) GetStartTime

func (m *TransferOperation) GetStartTime() *timestamp.Timestamp

func (*TransferOperation) GetStatus

func (*TransferOperation) GetTransferJobName

func (m *TransferOperation) GetTransferJobName() string

func (*TransferOperation) GetTransferSpec

func (m *TransferOperation) GetTransferSpec() *TransferSpec

func (*TransferOperation) ProtoMessage

func (*TransferOperation) ProtoMessage()

func (*TransferOperation) Reset

func (m *TransferOperation) Reset()

func (*TransferOperation) String

func (m *TransferOperation) String() string

func (*TransferOperation) XXX_DiscardUnknown

func (m *TransferOperation) XXX_DiscardUnknown()

func (*TransferOperation) XXX_Marshal

func (m *TransferOperation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TransferOperation) XXX_Merge

func (m *TransferOperation) XXX_Merge(src proto.Message)

func (*TransferOperation) XXX_Size

func (m *TransferOperation) XXX_Size() int

func (*TransferOperation) XXX_Unmarshal

func (m *TransferOperation) XXX_Unmarshal(b []byte) error

type TransferOperation_Status

type TransferOperation_Status int32

The status of a TransferOperation.

const (
	// Zero is an illegal value.
	TransferOperation_STATUS_UNSPECIFIED TransferOperation_Status = 0
	// In progress.
	TransferOperation_IN_PROGRESS TransferOperation_Status = 1
	// Paused.
	TransferOperation_PAUSED TransferOperation_Status = 2
	// Completed successfully.
	TransferOperation_SUCCESS TransferOperation_Status = 3
	// Terminated due to an unrecoverable failure.
	TransferOperation_FAILED TransferOperation_Status = 4
	// Aborted by the user.
	TransferOperation_ABORTED TransferOperation_Status = 5
)

func (TransferOperation_Status) EnumDescriptor

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

func (TransferOperation_Status) String

func (x TransferOperation_Status) String() string

type TransferOptions

type TransferOptions struct {
	// Whether overwriting objects that already exist in the sink is allowed.
	OverwriteObjectsAlreadyExistingInSink bool `` /* 181-byte string literal not displayed */
	// Whether objects that exist only in the sink should be deleted.  Note that
	// this option and `deleteObjectsFromSourceAfterTransfer` are mutually
	// exclusive.
	DeleteObjectsUniqueInSink bool `` /* 143-byte string literal not displayed */
	// Whether objects should be deleted from the source after they are
	// transferred to the sink.  Note that this option and
	// `deleteObjectsUniqueInSink` are mutually exclusive.
	DeleteObjectsFromSourceAfterTransfer bool     `` /* 178-byte string literal not displayed */
	XXX_NoUnkeyedLiteral                 struct{} `json:"-"`
	XXX_unrecognized                     []byte   `json:"-"`
	XXX_sizecache                        int32    `json:"-"`
}

TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer.

func (*TransferOptions) Descriptor

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

func (*TransferOptions) GetDeleteObjectsFromSourceAfterTransfer

func (m *TransferOptions) GetDeleteObjectsFromSourceAfterTransfer() bool

func (*TransferOptions) GetDeleteObjectsUniqueInSink

func (m *TransferOptions) GetDeleteObjectsUniqueInSink() bool

func (*TransferOptions) GetOverwriteObjectsAlreadyExistingInSink

func (m *TransferOptions) GetOverwriteObjectsAlreadyExistingInSink() bool

func (*TransferOptions) ProtoMessage

func (*TransferOptions) ProtoMessage()

func (*TransferOptions) Reset

func (m *TransferOptions) Reset()

func (*TransferOptions) String

func (m *TransferOptions) String() string

func (*TransferOptions) XXX_DiscardUnknown

func (m *TransferOptions) XXX_DiscardUnknown()

func (*TransferOptions) XXX_Marshal

func (m *TransferOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TransferOptions) XXX_Merge

func (m *TransferOptions) XXX_Merge(src proto.Message)

func (*TransferOptions) XXX_Size

func (m *TransferOptions) XXX_Size() int

func (*TransferOptions) XXX_Unmarshal

func (m *TransferOptions) XXX_Unmarshal(b []byte) error

type TransferSpec

type TransferSpec struct {
	// The read source of the data.
	//
	// Types that are valid to be assigned to DataSource:
	//	*TransferSpec_GcsDataSource
	//	*TransferSpec_AwsS3DataSource
	//	*TransferSpec_HttpDataSource
	DataSource isTransferSpec_DataSource `protobuf_oneof:"data_source"`
	// The write sink for the data.
	//
	// Types that are valid to be assigned to DataSink:
	//	*TransferSpec_GcsDataSink
	DataSink isTransferSpec_DataSink `protobuf_oneof:"data_sink"`
	// Only objects that satisfy these object conditions are included in the set
	// of data source and data sink objects.  Object conditions based on
	// objects' `lastModificationTime` 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 `deleteObjectsUniqueInSink` is `true`, object conditions
	// based on objects' `lastModificationTime` are ignored and do not exclude
	// objects in a data source or a data sink.
	TransferOptions      *TransferOptions `protobuf:"bytes,6,opt,name=transfer_options,json=transferOptions,proto3" json:"transfer_options,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

Configuration for running a transfer.

func (*TransferSpec) Descriptor

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

func (*TransferSpec) GetAwsS3DataSource

func (m *TransferSpec) GetAwsS3DataSource() *AwsS3Data

func (*TransferSpec) GetDataSink

func (m *TransferSpec) GetDataSink() isTransferSpec_DataSink

func (*TransferSpec) GetDataSource

func (m *TransferSpec) GetDataSource() isTransferSpec_DataSource

func (*TransferSpec) GetGcsDataSink

func (m *TransferSpec) GetGcsDataSink() *GcsData

func (*TransferSpec) GetGcsDataSource

func (m *TransferSpec) GetGcsDataSource() *GcsData

func (*TransferSpec) GetHttpDataSource

func (m *TransferSpec) GetHttpDataSource() *HttpData

func (*TransferSpec) GetObjectConditions

func (m *TransferSpec) GetObjectConditions() *ObjectConditions

func (*TransferSpec) GetTransferOptions

func (m *TransferSpec) GetTransferOptions() *TransferOptions

func (*TransferSpec) ProtoMessage

func (*TransferSpec) ProtoMessage()

func (*TransferSpec) Reset

func (m *TransferSpec) Reset()

func (*TransferSpec) String

func (m *TransferSpec) String() string

func (*TransferSpec) XXX_DiscardUnknown

func (m *TransferSpec) XXX_DiscardUnknown()

func (*TransferSpec) XXX_Marshal

func (m *TransferSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TransferSpec) XXX_Merge

func (m *TransferSpec) XXX_Merge(src proto.Message)

func (*TransferSpec) XXX_OneofFuncs

func (*TransferSpec) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

func (*TransferSpec) XXX_Size

func (m *TransferSpec) XXX_Size() int

func (*TransferSpec) XXX_Unmarshal

func (m *TransferSpec) XXX_Unmarshal(b []byte) error

type TransferSpec_AwsS3DataSource

type TransferSpec_AwsS3DataSource struct {
	AwsS3DataSource *AwsS3Data `protobuf:"bytes,2,opt,name=aws_s3_data_source,json=awsS3DataSource,proto3,oneof"`
}

type TransferSpec_GcsDataSink

type TransferSpec_GcsDataSink struct {
	GcsDataSink *GcsData `protobuf:"bytes,4,opt,name=gcs_data_sink,json=gcsDataSink,proto3,oneof"`
}

type TransferSpec_GcsDataSource

type TransferSpec_GcsDataSource struct {
	GcsDataSource *GcsData `protobuf:"bytes,1,opt,name=gcs_data_source,json=gcsDataSource,proto3,oneof"`
}

type TransferSpec_HttpDataSource

type TransferSpec_HttpDataSource struct {
	HttpDataSource *HttpData `protobuf:"bytes,3,opt,name=http_data_source,json=httpDataSource,proto3,oneof"`
}

type UpdateTransferJobRequest

type UpdateTransferJobRequest struct {
	// The name of job to update.
	// Required.
	JobName string `protobuf:"bytes,1,opt,name=job_name,json=jobName,proto3" json:"job_name,omitempty"`
	// The ID of the Google Cloud Platform Console project that owns the job.
	// Required.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The job to update. `transferJob` is expected to specify only three fields:
	// `description`, `transferSpec`, and `status`.  An UpdateTransferJobRequest
	// that specifies other fields will be rejected with an error
	// `INVALID_ARGUMENT`.
	// Required.
	TransferJob *TransferJob `protobuf:"bytes,3,opt,name=transfer_job,json=transferJob,proto3" json:"transfer_job,omitempty"`
	// The field mask of the fields in `transferJob` that are to be updated in
	// this request.  Fields in `transferJob` that can be updated are:
	// `description`, `transferSpec`, and `status`.  To update the `transferSpec`
	// of the job, a complete transfer specification has to be provided. An
	// incomplete specification which misses any required fields will be rejected
	// with the error `INVALID_ARGUMENT`.
	UpdateTransferJobFieldMask *field_mask.FieldMask `` /* 145-byte string literal not displayed */
	XXX_NoUnkeyedLiteral       struct{}              `json:"-"`
	XXX_unrecognized           []byte                `json:"-"`
	XXX_sizecache              int32                 `json:"-"`
}

Request passed to UpdateTransferJob.

func (*UpdateTransferJobRequest) Descriptor

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

func (*UpdateTransferJobRequest) GetJobName

func (m *UpdateTransferJobRequest) GetJobName() string

func (*UpdateTransferJobRequest) GetProjectId

func (m *UpdateTransferJobRequest) GetProjectId() string

func (*UpdateTransferJobRequest) GetTransferJob

func (m *UpdateTransferJobRequest) GetTransferJob() *TransferJob

func (*UpdateTransferJobRequest) GetUpdateTransferJobFieldMask

func (m *UpdateTransferJobRequest) GetUpdateTransferJobFieldMask() *field_mask.FieldMask

func (*UpdateTransferJobRequest) ProtoMessage

func (*UpdateTransferJobRequest) ProtoMessage()

func (*UpdateTransferJobRequest) Reset

func (m *UpdateTransferJobRequest) Reset()

func (*UpdateTransferJobRequest) String

func (m *UpdateTransferJobRequest) String() string

func (*UpdateTransferJobRequest) XXX_DiscardUnknown

func (m *UpdateTransferJobRequest) XXX_DiscardUnknown()

func (*UpdateTransferJobRequest) XXX_Marshal

func (m *UpdateTransferJobRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateTransferJobRequest) XXX_Merge

func (m *UpdateTransferJobRequest) XXX_Merge(src proto.Message)

func (*UpdateTransferJobRequest) XXX_Size

func (m *UpdateTransferJobRequest) XXX_Size() int

func (*UpdateTransferJobRequest) XXX_Unmarshal

func (m *UpdateTransferJobRequest) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL