genproto: google.golang.org/genproto/googleapis/storagetransfer/v1 Index | Files

package storagetransfer

import "google.golang.org/genproto/googleapis/storagetransfer/v1"

Index

Package Files

transfer.pb.go transfer_types.pb.go

Variables

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.

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

Enum value maps for TransferOperation_Status.

var File_google_storagetransfer_v1_transfer_proto protoreflect.FileDescriptor
var File_google_storagetransfer_v1_transfer_types_proto protoreflect.FileDescriptor

func RegisterStorageTransferServiceServer Uses

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

type AwsAccessKey Uses

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"`
    // contains filtered or unexported fields
}

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

func (*AwsAccessKey) Descriptor Uses

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

Deprecated: Use AwsAccessKey.ProtoReflect.Descriptor instead.

func (*AwsAccessKey) GetAccessKeyId Uses

func (x *AwsAccessKey) GetAccessKeyId() string

func (*AwsAccessKey) GetSecretAccessKey Uses

func (x *AwsAccessKey) GetSecretAccessKey() string

func (*AwsAccessKey) ProtoMessage Uses

func (*AwsAccessKey) ProtoMessage()

func (*AwsAccessKey) ProtoReflect Uses

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

func (*AwsAccessKey) Reset Uses

func (x *AwsAccessKey) Reset()

func (*AwsAccessKey) String Uses

func (x *AwsAccessKey) String() string

type AwsS3Data Uses

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"`
    // contains filtered or unexported fields
}

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 Uses

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

Deprecated: Use AwsS3Data.ProtoReflect.Descriptor instead.

func (*AwsS3Data) GetAwsAccessKey Uses

func (x *AwsS3Data) GetAwsAccessKey() *AwsAccessKey

func (*AwsS3Data) GetBucketName Uses

func (x *AwsS3Data) GetBucketName() string

func (*AwsS3Data) ProtoMessage Uses

func (*AwsS3Data) ProtoMessage()

func (*AwsS3Data) ProtoReflect Uses

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

func (*AwsS3Data) Reset Uses

func (x *AwsS3Data) Reset()

func (*AwsS3Data) String Uses

func (x *AwsS3Data) String() string

type CreateTransferJobRequest Uses

type CreateTransferJobRequest struct {

    // The job to create.
    // Required.
    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 Uses

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

Deprecated: Use CreateTransferJobRequest.ProtoReflect.Descriptor instead.

func (*CreateTransferJobRequest) GetTransferJob Uses

func (x *CreateTransferJobRequest) GetTransferJob() *TransferJob

func (*CreateTransferJobRequest) ProtoMessage Uses

func (*CreateTransferJobRequest) ProtoMessage()

func (*CreateTransferJobRequest) ProtoReflect Uses

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

func (*CreateTransferJobRequest) Reset Uses

func (x *CreateTransferJobRequest) Reset()

func (*CreateTransferJobRequest) String Uses

func (x *CreateTransferJobRequest) String() string

type ErrorLogEntry Uses

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"`
    // contains filtered or unexported fields
}

An entry describing an error that has occurred.

func (*ErrorLogEntry) Descriptor Uses

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

Deprecated: Use ErrorLogEntry.ProtoReflect.Descriptor instead.

func (*ErrorLogEntry) GetErrorDetails Uses

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

func (*ErrorLogEntry) GetUrl Uses

func (x *ErrorLogEntry) GetUrl() string

func (*ErrorLogEntry) ProtoMessage Uses

func (*ErrorLogEntry) ProtoMessage()

func (*ErrorLogEntry) ProtoReflect Uses

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

func (*ErrorLogEntry) Reset Uses

func (x *ErrorLogEntry) Reset()

func (*ErrorLogEntry) String Uses

func (x *ErrorLogEntry) String() string

type ErrorSummary Uses

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"`
    // contains filtered or unexported fields
}

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

func (*ErrorSummary) Descriptor Uses

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

Deprecated: Use ErrorSummary.ProtoReflect.Descriptor instead.

func (*ErrorSummary) GetErrorCode Uses

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

func (*ErrorSummary) GetErrorCount Uses

func (x *ErrorSummary) GetErrorCount() int64

func (*ErrorSummary) GetErrorLogEntries Uses

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

func (*ErrorSummary) ProtoMessage Uses

func (*ErrorSummary) ProtoMessage()

func (*ErrorSummary) ProtoReflect Uses

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

func (*ErrorSummary) Reset Uses

func (x *ErrorSummary) Reset()

func (*ErrorSummary) String Uses

func (x *ErrorSummary) String() string

type GcsData Uses

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"`
    // contains filtered or unexported fields
}

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 Uses

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

Deprecated: Use GcsData.ProtoReflect.Descriptor instead.

func (*GcsData) GetBucketName Uses

func (x *GcsData) GetBucketName() string

func (*GcsData) ProtoMessage Uses

func (*GcsData) ProtoMessage()

func (*GcsData) ProtoReflect Uses

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

func (*GcsData) Reset Uses

func (x *GcsData) Reset()

func (*GcsData) String Uses

func (x *GcsData) String() string

type GetGoogleServiceAccountRequest Uses

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"`
    // contains filtered or unexported fields
}

Request passed to GetGoogleServiceAccount.

func (*GetGoogleServiceAccountRequest) Descriptor Uses

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

Deprecated: Use GetGoogleServiceAccountRequest.ProtoReflect.Descriptor instead.

func (*GetGoogleServiceAccountRequest) GetProjectId Uses

func (x *GetGoogleServiceAccountRequest) GetProjectId() string

func (*GetGoogleServiceAccountRequest) ProtoMessage Uses

func (*GetGoogleServiceAccountRequest) ProtoMessage()

func (*GetGoogleServiceAccountRequest) ProtoReflect Uses

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

func (*GetGoogleServiceAccountRequest) Reset Uses

func (x *GetGoogleServiceAccountRequest) Reset()

func (*GetGoogleServiceAccountRequest) String Uses

func (x *GetGoogleServiceAccountRequest) String() string

type GetTransferJobRequest Uses

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"`
    // contains filtered or unexported fields
}

Request passed to GetTransferJob.

func (*GetTransferJobRequest) Descriptor Uses

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

Deprecated: Use GetTransferJobRequest.ProtoReflect.Descriptor instead.

func (*GetTransferJobRequest) GetJobName Uses

func (x *GetTransferJobRequest) GetJobName() string

func (*GetTransferJobRequest) GetProjectId Uses

func (x *GetTransferJobRequest) GetProjectId() string

func (*GetTransferJobRequest) ProtoMessage Uses

func (*GetTransferJobRequest) ProtoMessage()

func (*GetTransferJobRequest) ProtoReflect Uses

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

func (*GetTransferJobRequest) Reset Uses

func (x *GetTransferJobRequest) Reset()

func (*GetTransferJobRequest) String Uses

func (x *GetTransferJobRequest) String() string

type GoogleServiceAccount Uses

type GoogleServiceAccount struct {

    // Required.
    AccountEmail string `protobuf:"bytes,1,opt,name=account_email,json=accountEmail,proto3" json:"account_email,omitempty"`
    // contains filtered or unexported fields
}

Google service account

func (*GoogleServiceAccount) Descriptor Uses

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

Deprecated: Use GoogleServiceAccount.ProtoReflect.Descriptor instead.

func (*GoogleServiceAccount) GetAccountEmail Uses

func (x *GoogleServiceAccount) GetAccountEmail() string

func (*GoogleServiceAccount) ProtoMessage Uses

func (*GoogleServiceAccount) ProtoMessage()

func (*GoogleServiceAccount) ProtoReflect Uses

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

func (*GoogleServiceAccount) Reset Uses

func (x *GoogleServiceAccount) Reset()

func (*GoogleServiceAccount) String Uses

func (x *GoogleServiceAccount) String() string

type HttpData Uses

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"`
    // contains filtered or unexported fields
}

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 Uses

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

Deprecated: Use HttpData.ProtoReflect.Descriptor instead.

func (*HttpData) GetListUrl Uses

func (x *HttpData) GetListUrl() string

func (*HttpData) ProtoMessage Uses

func (*HttpData) ProtoMessage()

func (*HttpData) ProtoReflect Uses

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

func (*HttpData) Reset Uses

func (x *HttpData) Reset()

func (*HttpData) String Uses

func (x *HttpData) String() string

type ListTransferJobsRequest Uses

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"`
    // contains filtered or unexported fields
}

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

func (*ListTransferJobsRequest) Descriptor Uses

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

Deprecated: Use ListTransferJobsRequest.ProtoReflect.Descriptor instead.

func (*ListTransferJobsRequest) GetFilter Uses

func (x *ListTransferJobsRequest) GetFilter() string

func (*ListTransferJobsRequest) GetPageSize Uses

func (x *ListTransferJobsRequest) GetPageSize() int32

func (*ListTransferJobsRequest) GetPageToken Uses

func (x *ListTransferJobsRequest) GetPageToken() string

func (*ListTransferJobsRequest) ProtoMessage Uses

func (*ListTransferJobsRequest) ProtoMessage()

func (*ListTransferJobsRequest) ProtoReflect Uses

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

func (*ListTransferJobsRequest) Reset Uses

func (x *ListTransferJobsRequest) Reset()

func (*ListTransferJobsRequest) String Uses

func (x *ListTransferJobsRequest) String() string

type ListTransferJobsResponse Uses

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 Uses

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

Deprecated: Use ListTransferJobsResponse.ProtoReflect.Descriptor instead.

func (*ListTransferJobsResponse) GetNextPageToken Uses

func (x *ListTransferJobsResponse) GetNextPageToken() string

func (*ListTransferJobsResponse) GetTransferJobs Uses

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

func (*ListTransferJobsResponse) ProtoMessage Uses

func (*ListTransferJobsResponse) ProtoMessage()

func (*ListTransferJobsResponse) ProtoReflect Uses

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

func (*ListTransferJobsResponse) Reset Uses

func (x *ListTransferJobsResponse) Reset()

func (*ListTransferJobsResponse) String Uses

func (x *ListTransferJobsResponse) String() string

type ObjectConditions Uses

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 `protobuf:"bytes,1,opt,name=min_time_elapsed_since_last_modification,json=minTimeElapsedSinceLastModification,proto3" json:"min_time_elapsed_since_last_modification,omitempty"`
    // `maxTimeElapsedSinceLastModification` is the complement to
    // `minTimeElapsedSinceLastModification`.
    MaxTimeElapsedSinceLastModification *duration.Duration `protobuf:"bytes,2,opt,name=max_time_elapsed_since_last_modification,json=maxTimeElapsedSinceLastModification,proto3" json:"max_time_elapsed_since_last_modification,omitempty"`
    // 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"`
    // contains filtered or unexported fields
}

Conditions that determine which objects will be transferred.

func (*ObjectConditions) Descriptor Uses

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

Deprecated: Use ObjectConditions.ProtoReflect.Descriptor instead.

func (*ObjectConditions) GetExcludePrefixes Uses

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

func (*ObjectConditions) GetIncludePrefixes Uses

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

func (*ObjectConditions) GetMaxTimeElapsedSinceLastModification Uses

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

func (*ObjectConditions) GetMinTimeElapsedSinceLastModification Uses

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

func (*ObjectConditions) ProtoMessage Uses

func (*ObjectConditions) ProtoMessage()

func (*ObjectConditions) ProtoReflect Uses

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

func (*ObjectConditions) Reset Uses

func (x *ObjectConditions) Reset()

func (*ObjectConditions) String Uses

func (x *ObjectConditions) String() string

type PauseTransferOperationRequest Uses

type PauseTransferOperationRequest struct {

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

Request passed to PauseTransferOperation.

func (*PauseTransferOperationRequest) Descriptor Uses

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

Deprecated: Use PauseTransferOperationRequest.ProtoReflect.Descriptor instead.

func (*PauseTransferOperationRequest) GetName Uses

func (x *PauseTransferOperationRequest) GetName() string

func (*PauseTransferOperationRequest) ProtoMessage Uses

func (*PauseTransferOperationRequest) ProtoMessage()

func (*PauseTransferOperationRequest) ProtoReflect Uses

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

func (*PauseTransferOperationRequest) Reset Uses

func (x *PauseTransferOperationRequest) Reset()

func (*PauseTransferOperationRequest) String Uses

func (x *PauseTransferOperationRequest) String() string

type ResumeTransferOperationRequest Uses

type ResumeTransferOperationRequest struct {

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

Request passed to ResumeTransferOperation.

func (*ResumeTransferOperationRequest) Descriptor Uses

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

Deprecated: Use ResumeTransferOperationRequest.ProtoReflect.Descriptor instead.

func (*ResumeTransferOperationRequest) GetName Uses

func (x *ResumeTransferOperationRequest) GetName() string

func (*ResumeTransferOperationRequest) ProtoMessage Uses

func (*ResumeTransferOperationRequest) ProtoMessage()

func (*ResumeTransferOperationRequest) ProtoReflect Uses

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

func (*ResumeTransferOperationRequest) Reset Uses

func (x *ResumeTransferOperationRequest) Reset()

func (*ResumeTransferOperationRequest) String Uses

func (x *ResumeTransferOperationRequest) String() string

type Schedule Uses

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"`
    // contains filtered or unexported fields
}

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

func (*Schedule) Descriptor Uses

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

Deprecated: Use Schedule.ProtoReflect.Descriptor instead.

func (*Schedule) GetScheduleEndDate Uses

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

func (*Schedule) GetScheduleStartDate Uses

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

func (*Schedule) GetStartTimeOfDay Uses

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

func (*Schedule) ProtoMessage Uses

func (*Schedule) ProtoMessage()

func (*Schedule) ProtoReflect Uses

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

func (*Schedule) Reset Uses

func (x *Schedule) Reset()

func (*Schedule) String Uses

func (x *Schedule) String() string

type StorageTransferServiceClient Uses

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 Uses

func NewStorageTransferServiceClient(cc grpc.ClientConnInterface) StorageTransferServiceClient

type StorageTransferServiceServer Uses

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 Uses

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 `protobuf:"varint,1,opt,name=objects_found_from_source,json=objectsFoundFromSource,proto3" json:"objects_found_from_source,omitempty"`
    // 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 `protobuf:"varint,2,opt,name=bytes_found_from_source,json=bytesFoundFromSource,proto3" json:"bytes_found_from_source,omitempty"`
    // Objects found only in the data sink that are scheduled to be deleted.
    ObjectsFoundOnlyFromSink int64 `protobuf:"varint,3,opt,name=objects_found_only_from_sink,json=objectsFoundOnlyFromSink,proto3" json:"objects_found_only_from_sink,omitempty"`
    // Bytes found only in the data sink that are scheduled to be deleted.
    BytesFoundOnlyFromSink int64 `protobuf:"varint,4,opt,name=bytes_found_only_from_sink,json=bytesFoundOnlyFromSink,proto3" json:"bytes_found_only_from_sink,omitempty"`
    // Objects in the data source that are not transferred because they already
    // exist in the data sink.
    ObjectsFromSourceSkippedBySync int64 `protobuf:"varint,5,opt,name=objects_from_source_skipped_by_sync,json=objectsFromSourceSkippedBySync,proto3" json:"objects_from_source_skipped_by_sync,omitempty"`
    // Bytes in the data source that are not transferred because they already
    // exist in the data sink.
    BytesFromSourceSkippedBySync int64 `protobuf:"varint,6,opt,name=bytes_from_source_skipped_by_sync,json=bytesFromSourceSkippedBySync,proto3" json:"bytes_from_source_skipped_by_sync,omitempty"`
    // 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 `protobuf:"varint,9,opt,name=objects_deleted_from_source,json=objectsDeletedFromSource,proto3" json:"objects_deleted_from_source,omitempty"`
    // Bytes that are deleted from the data source.
    BytesDeletedFromSource int64 `protobuf:"varint,10,opt,name=bytes_deleted_from_source,json=bytesDeletedFromSource,proto3" json:"bytes_deleted_from_source,omitempty"`
    // Objects that are deleted from the data sink.
    ObjectsDeletedFromSink int64 `protobuf:"varint,11,opt,name=objects_deleted_from_sink,json=objectsDeletedFromSink,proto3" json:"objects_deleted_from_sink,omitempty"`
    // Bytes that are deleted from the data sink.
    BytesDeletedFromSink int64 `protobuf:"varint,12,opt,name=bytes_deleted_from_sink,json=bytesDeletedFromSink,proto3" json:"bytes_deleted_from_sink,omitempty"`
    // Objects in the data source that failed during the transfer.
    ObjectsFromSourceFailed int64 `protobuf:"varint,13,opt,name=objects_from_source_failed,json=objectsFromSourceFailed,proto3" json:"objects_from_source_failed,omitempty"`
    // Bytes in the data source that failed during the transfer.
    BytesFromSourceFailed int64 `protobuf:"varint,14,opt,name=bytes_from_source_failed,json=bytesFromSourceFailed,proto3" json:"bytes_from_source_failed,omitempty"`
    // Objects that failed to be deleted from the data sink.
    ObjectsFailedToDeleteFromSink int64 `protobuf:"varint,15,opt,name=objects_failed_to_delete_from_sink,json=objectsFailedToDeleteFromSink,proto3" json:"objects_failed_to_delete_from_sink,omitempty"`
    // Bytes that failed to be deleted from the data sink.
    BytesFailedToDeleteFromSink int64 `protobuf:"varint,16,opt,name=bytes_failed_to_delete_from_sink,json=bytesFailedToDeleteFromSink,proto3" json:"bytes_failed_to_delete_from_sink,omitempty"`
    // contains filtered or unexported fields
}

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

func (*TransferCounters) Descriptor Uses

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

Deprecated: Use TransferCounters.ProtoReflect.Descriptor instead.

func (*TransferCounters) GetBytesCopiedToSink Uses

func (x *TransferCounters) GetBytesCopiedToSink() int64

func (*TransferCounters) GetBytesDeletedFromSink Uses

func (x *TransferCounters) GetBytesDeletedFromSink() int64

func (*TransferCounters) GetBytesDeletedFromSource Uses

func (x *TransferCounters) GetBytesDeletedFromSource() int64

func (*TransferCounters) GetBytesFailedToDeleteFromSink Uses

func (x *TransferCounters) GetBytesFailedToDeleteFromSink() int64

func (*TransferCounters) GetBytesFoundFromSource Uses

func (x *TransferCounters) GetBytesFoundFromSource() int64

func (*TransferCounters) GetBytesFoundOnlyFromSink Uses

func (x *TransferCounters) GetBytesFoundOnlyFromSink() int64

func (*TransferCounters) GetBytesFromSourceFailed Uses

func (x *TransferCounters) GetBytesFromSourceFailed() int64

func (*TransferCounters) GetBytesFromSourceSkippedBySync Uses

func (x *TransferCounters) GetBytesFromSourceSkippedBySync() int64

func (*TransferCounters) GetObjectsCopiedToSink Uses

func (x *TransferCounters) GetObjectsCopiedToSink() int64

func (*TransferCounters) GetObjectsDeletedFromSink Uses

func (x *TransferCounters) GetObjectsDeletedFromSink() int64

func (*TransferCounters) GetObjectsDeletedFromSource Uses

func (x *TransferCounters) GetObjectsDeletedFromSource() int64

func (*TransferCounters) GetObjectsFailedToDeleteFromSink Uses

func (x *TransferCounters) GetObjectsFailedToDeleteFromSink() int64

func (*TransferCounters) GetObjectsFoundFromSource Uses

func (x *TransferCounters) GetObjectsFoundFromSource() int64

func (*TransferCounters) GetObjectsFoundOnlyFromSink Uses

func (x *TransferCounters) GetObjectsFoundOnlyFromSink() int64

func (*TransferCounters) GetObjectsFromSourceFailed Uses

func (x *TransferCounters) GetObjectsFromSourceFailed() int64

func (*TransferCounters) GetObjectsFromSourceSkippedBySync Uses

func (x *TransferCounters) GetObjectsFromSourceSkippedBySync() int64

func (*TransferCounters) ProtoMessage Uses

func (*TransferCounters) ProtoMessage()

func (*TransferCounters) ProtoReflect Uses

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

func (*TransferCounters) Reset Uses

func (x *TransferCounters) Reset()

func (*TransferCounters) String Uses

func (x *TransferCounters) String() string

type TransferJob Uses

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"`
    // contains filtered or unexported fields
}

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

func (*TransferJob) Descriptor Uses

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

Deprecated: Use TransferJob.ProtoReflect.Descriptor instead.

func (*TransferJob) GetCreationTime Uses

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

func (*TransferJob) GetDeletionTime Uses

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

func (*TransferJob) GetDescription Uses

func (x *TransferJob) GetDescription() string

func (*TransferJob) GetLastModificationTime Uses

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

func (*TransferJob) GetName Uses

func (x *TransferJob) GetName() string

func (*TransferJob) GetProjectId Uses

func (x *TransferJob) GetProjectId() string

func (*TransferJob) GetSchedule Uses

func (x *TransferJob) GetSchedule() *Schedule

func (*TransferJob) GetStatus Uses

func (x *TransferJob) GetStatus() TransferJob_Status

func (*TransferJob) GetTransferSpec Uses

func (x *TransferJob) GetTransferSpec() *TransferSpec

func (*TransferJob) ProtoMessage Uses

func (*TransferJob) ProtoMessage()

func (*TransferJob) ProtoReflect Uses

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

func (*TransferJob) Reset Uses

func (x *TransferJob) Reset()

func (*TransferJob) String Uses

func (x *TransferJob) String() string

type TransferJob_Status Uses

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

func (TransferJob_Status) Descriptor() protoreflect.EnumDescriptor

func (TransferJob_Status) Enum Uses

func (x TransferJob_Status) Enum() *TransferJob_Status

func (TransferJob_Status) EnumDescriptor Uses

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

Deprecated: Use TransferJob_Status.Descriptor instead.

func (TransferJob_Status) Number Uses

func (x TransferJob_Status) Number() protoreflect.EnumNumber

func (TransferJob_Status) String Uses

func (x TransferJob_Status) String() string

func (TransferJob_Status) Type Uses

func (TransferJob_Status) Type() protoreflect.EnumType

type TransferOperation Uses

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"`
    // contains filtered or unexported fields
}

A description of the execution of a transfer.

func (*TransferOperation) Descriptor Uses

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

Deprecated: Use TransferOperation.ProtoReflect.Descriptor instead.

func (*TransferOperation) GetCounters Uses

func (x *TransferOperation) GetCounters() *TransferCounters

func (*TransferOperation) GetEndTime Uses

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

func (*TransferOperation) GetErrorBreakdowns Uses

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

func (*TransferOperation) GetName Uses

func (x *TransferOperation) GetName() string

func (*TransferOperation) GetProjectId Uses

func (x *TransferOperation) GetProjectId() string

func (*TransferOperation) GetStartTime Uses

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

func (*TransferOperation) GetStatus Uses

func (x *TransferOperation) GetStatus() TransferOperation_Status

func (*TransferOperation) GetTransferJobName Uses

func (x *TransferOperation) GetTransferJobName() string

func (*TransferOperation) GetTransferSpec Uses

func (x *TransferOperation) GetTransferSpec() *TransferSpec

func (*TransferOperation) ProtoMessage Uses

func (*TransferOperation) ProtoMessage()

func (*TransferOperation) ProtoReflect Uses

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

func (*TransferOperation) Reset Uses

func (x *TransferOperation) Reset()

func (*TransferOperation) String Uses

func (x *TransferOperation) String() string

type TransferOperation_Status Uses

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

func (TransferOperation_Status) Descriptor() protoreflect.EnumDescriptor

func (TransferOperation_Status) Enum Uses

func (x TransferOperation_Status) Enum() *TransferOperation_Status

func (TransferOperation_Status) EnumDescriptor Uses

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

Deprecated: Use TransferOperation_Status.Descriptor instead.

func (TransferOperation_Status) Number Uses

func (x TransferOperation_Status) Number() protoreflect.EnumNumber

func (TransferOperation_Status) String Uses

func (x TransferOperation_Status) String() string

func (TransferOperation_Status) Type Uses

func (TransferOperation_Status) Type() protoreflect.EnumType

type TransferOptions Uses

type TransferOptions struct {

    // Whether overwriting objects that already exist in the sink is allowed.
    OverwriteObjectsAlreadyExistingInSink bool `protobuf:"varint,1,opt,name=overwrite_objects_already_existing_in_sink,json=overwriteObjectsAlreadyExistingInSink,proto3" json:"overwrite_objects_already_existing_in_sink,omitempty"`
    // Whether objects that exist only in the sink should be deleted.  Note that
    // this option and `deleteObjectsFromSourceAfterTransfer` are mutually
    // exclusive.
    DeleteObjectsUniqueInSink bool `protobuf:"varint,2,opt,name=delete_objects_unique_in_sink,json=deleteObjectsUniqueInSink,proto3" json:"delete_objects_unique_in_sink,omitempty"`
    // 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 `protobuf:"varint,3,opt,name=delete_objects_from_source_after_transfer,json=deleteObjectsFromSourceAfterTransfer,proto3" json:"delete_objects_from_source_after_transfer,omitempty"`
    // contains filtered or unexported fields
}

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

func (*TransferOptions) Descriptor Uses

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

Deprecated: Use TransferOptions.ProtoReflect.Descriptor instead.

func (*TransferOptions) GetDeleteObjectsFromSourceAfterTransfer Uses

func (x *TransferOptions) GetDeleteObjectsFromSourceAfterTransfer() bool

func (*TransferOptions) GetDeleteObjectsUniqueInSink Uses

func (x *TransferOptions) GetDeleteObjectsUniqueInSink() bool

func (*TransferOptions) GetOverwriteObjectsAlreadyExistingInSink Uses

func (x *TransferOptions) GetOverwriteObjectsAlreadyExistingInSink() bool

func (*TransferOptions) ProtoMessage Uses

func (*TransferOptions) ProtoMessage()

func (*TransferOptions) ProtoReflect Uses

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

func (*TransferOptions) Reset Uses

func (x *TransferOptions) Reset()

func (*TransferOptions) String Uses

func (x *TransferOptions) String() string

type TransferSpec Uses

type TransferSpec struct {

    // The read source of the data.
    //
    // Types that are assignable to DataSource:
    //	*TransferSpec_GcsDataSource
    //	*TransferSpec_AwsS3DataSource
    //	*TransferSpec_HttpDataSource
    DataSource isTransferSpec_DataSource `protobuf_oneof:"data_source"`
    // The write sink for the data.
    //
    // Types that are assignable 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"`
    // contains filtered or unexported fields
}

Configuration for running a transfer.

func (*TransferSpec) Descriptor Uses

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

Deprecated: Use TransferSpec.ProtoReflect.Descriptor instead.

func (*TransferSpec) GetAwsS3DataSource Uses

func (x *TransferSpec) GetAwsS3DataSource() *AwsS3Data

func (*TransferSpec) GetDataSink Uses

func (m *TransferSpec) GetDataSink() isTransferSpec_DataSink

func (*TransferSpec) GetDataSource Uses

func (m *TransferSpec) GetDataSource() isTransferSpec_DataSource

func (*TransferSpec) GetGcsDataSink Uses

func (x *TransferSpec) GetGcsDataSink() *GcsData

func (*TransferSpec) GetGcsDataSource Uses

func (x *TransferSpec) GetGcsDataSource() *GcsData

func (*TransferSpec) GetHttpDataSource Uses

func (x *TransferSpec) GetHttpDataSource() *HttpData

func (*TransferSpec) GetObjectConditions Uses

func (x *TransferSpec) GetObjectConditions() *ObjectConditions

func (*TransferSpec) GetTransferOptions Uses

func (x *TransferSpec) GetTransferOptions() *TransferOptions

func (*TransferSpec) ProtoMessage Uses

func (*TransferSpec) ProtoMessage()

func (*TransferSpec) ProtoReflect Uses

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

func (*TransferSpec) Reset Uses

func (x *TransferSpec) Reset()

func (*TransferSpec) String Uses

func (x *TransferSpec) String() string

type TransferSpec_AwsS3DataSource Uses

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

type TransferSpec_GcsDataSink Uses

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

type TransferSpec_GcsDataSource Uses

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

type TransferSpec_HttpDataSource Uses

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

type UnimplementedStorageTransferServiceServer Uses

type UnimplementedStorageTransferServiceServer struct {
}

UnimplementedStorageTransferServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedStorageTransferServiceServer) CreateTransferJob Uses

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

func (*UnimplementedStorageTransferServiceServer) GetGoogleServiceAccount Uses

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

func (*UnimplementedStorageTransferServiceServer) GetTransferJob Uses

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

func (*UnimplementedStorageTransferServiceServer) ListTransferJobs Uses

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

func (*UnimplementedStorageTransferServiceServer) PauseTransferOperation Uses

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

func (*UnimplementedStorageTransferServiceServer) ResumeTransferOperation Uses

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

func (*UnimplementedStorageTransferServiceServer) UpdateTransferJob Uses

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

type UpdateTransferJobRequest Uses

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 `protobuf:"bytes,4,opt,name=update_transfer_job_field_mask,json=updateTransferJobFieldMask,proto3" json:"update_transfer_job_field_mask,omitempty"`
    // contains filtered or unexported fields
}

Request passed to UpdateTransferJob.

func (*UpdateTransferJobRequest) Descriptor Uses

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

Deprecated: Use UpdateTransferJobRequest.ProtoReflect.Descriptor instead.

func (*UpdateTransferJobRequest) GetJobName Uses

func (x *UpdateTransferJobRequest) GetJobName() string

func (*UpdateTransferJobRequest) GetProjectId Uses

func (x *UpdateTransferJobRequest) GetProjectId() string

func (*UpdateTransferJobRequest) GetTransferJob Uses

func (x *UpdateTransferJobRequest) GetTransferJob() *TransferJob

func (*UpdateTransferJobRequest) GetUpdateTransferJobFieldMask Uses

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

func (*UpdateTransferJobRequest) ProtoMessage Uses

func (*UpdateTransferJobRequest) ProtoMessage()

func (*UpdateTransferJobRequest) ProtoReflect Uses

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

func (*UpdateTransferJobRequest) Reset Uses

func (x *UpdateTransferJobRequest) Reset()

func (*UpdateTransferJobRequest) String Uses

func (x *UpdateTransferJobRequest) String() string

Package storagetransfer imports 17 packages (graph). Updated 2020-07-08. Refresh now. Tools for package owners.