Package storagetransfer

import "google.golang.org/api/storagetransfer/v1"
...
storagetransferService, err := storagetransfer.New(oauthHttpClient)

Constants

OAuth2 scopes used by this API.

const (
    // View and manage your data across Google Cloud Platform services
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

type AwsAccessKey ¶

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

type AwsAccessKey struct {
    // AccessKeyId: AWS access key ID.
    // Required.
    AccessKeyId string `json:"accessKeyId,omitempty"`

    // SecretAccessKey: AWS secret access key. This field is not returned in
    // RPC responses.
    // Required.
    SecretAccessKey string `json:"secretAccessKey,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AccessKeyId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AccessKeyId") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*AwsAccessKey) MarshalJSON ¶

func (s *AwsAccessKey) MarshalJSON() ([]byte, error)

type AwsS3Data ¶

AwsS3Data: 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.

type AwsS3Data struct {
    // AwsAccessKey: 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 `json:"awsAccessKey,omitempty"`

    // BucketName: S3 Bucket name (see
    // [Creating a
    // bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-g
    // et-location-example.html)).
    // Required.
    BucketName string `json:"bucketName,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AwsAccessKey") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AwsAccessKey") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*AwsS3Data) MarshalJSON ¶

func (s *AwsS3Data) MarshalJSON() ([]byte, error)

type Date ¶

Date: Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

type Date struct {
    // Day: Day of month. Must be from 1 to 31 and valid for the year and
    // month, or 0
    // if specifying a year/month where the day is not significant.
    Day int64 `json:"day,omitempty"`

    // Month: Month of year. Must be from 1 to 12.
    Month int64 `json:"month,omitempty"`

    // Year: Year of date. Must be from 1 to 9999, or 0 if specifying a date
    // without
    // a year.
    Year int64 `json:"year,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Day") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Day") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Date) MarshalJSON ¶

func (s *Date) MarshalJSON() ([]byte, error)

type Empty ¶

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty);

}

The JSON representation for `Empty` is empty JSON object `{}`.

type Empty struct {
    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`
}

type ErrorLogEntry ¶

ErrorLogEntry: An entry describing an error that has occurred.

type ErrorLogEntry struct {
    // ErrorDetails: A list of messages that carry the error details.
    ErrorDetails []string `json:"errorDetails,omitempty"`

    // Url: 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 `json:"url,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ErrorDetails") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ErrorDetails") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ErrorLogEntry) MarshalJSON ¶

func (s *ErrorLogEntry) MarshalJSON() ([]byte, error)

type ErrorSummary ¶

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

type ErrorSummary struct {
    // ErrorCode: Required.
    //
    // Possible values:
    //   "OK" - Not an error; returned on success
    //
    // HTTP Mapping: 200 OK
    //   "CANCELLED" - The operation was cancelled, typically by the
    // caller.
    //
    // HTTP Mapping: 499 Client Closed Request
    //   "UNKNOWN" - Unknown error.  For example, this error may be returned
    // when
    // a `Status` value received from another address space belongs to
    // an error space that is not known in this address space.  Also
    // errors raised by APIs that do not return enough error information
    // may be converted to this error.
    //
    // HTTP Mapping: 500 Internal Server Error
    //   "INVALID_ARGUMENT" - The client specified an invalid argument.
    // Note that this differs
    // from `FAILED_PRECONDITION`.  `INVALID_ARGUMENT` indicates
    // arguments
    // that are problematic regardless of the state of the system
    // (e.g., a malformed file name).
    //
    // HTTP Mapping: 400 Bad Request
    //   "DEADLINE_EXCEEDED" - The deadline expired before the operation
    // could complete. For operations
    // that change the state of the system, this error may be returned
    // even if the operation has completed successfully.  For example,
    // a
    // successful response from a server could have been delayed long
    // enough for the deadline to expire.
    //
    // HTTP Mapping: 504 Gateway Timeout
    //   "NOT_FOUND" - Some requested entity (e.g., file or directory) was
    // not found.
    //
    // Note to server developers: if a request is denied for an entire
    // class
    // of users, such as gradual feature rollout or undocumented
    // whitelist,
    // `NOT_FOUND` may be used. If a request is denied for some users
    // within
    // a class of users, such as user-based access control,
    // `PERMISSION_DENIED`
    // must be used.
    //
    // HTTP Mapping: 404 Not Found
    //   "ALREADY_EXISTS" - The entity that a client attempted to create
    // (e.g., file or directory)
    // already exists.
    //
    // HTTP Mapping: 409 Conflict
    //   "PERMISSION_DENIED" - The caller does not have permission to
    // execute the specified
    // operation. `PERMISSION_DENIED` must not be used for rejections
    // caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
    // instead for those errors). `PERMISSION_DENIED` must not be
    // used if the caller can not be identified (use
    // `UNAUTHENTICATED`
    // instead for those errors). This error code does not imply the
    // request is valid or the requested entity exists or satisfies
    // other pre-conditions.
    //
    // HTTP Mapping: 403 Forbidden
    //   "UNAUTHENTICATED" - The request does not have valid authentication
    // credentials for the
    // operation.
    //
    // HTTP Mapping: 401 Unauthorized
    //   "RESOURCE_EXHAUSTED" - Some resource has been exhausted, perhaps a
    // per-user quota, or
    // perhaps the entire file system is out of space.
    //
    // HTTP Mapping: 429 Too Many Requests
    //   "FAILED_PRECONDITION" - The operation was rejected because the
    // system is not in a state
    // required for the operation's execution.  For example, the
    // directory
    // to be deleted is non-empty, an rmdir operation is applied to
    // a non-directory, etc.
    //
    // Service implementors can use the following guidelines to
    // decide
    // between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
    //  (a) Use `UNAVAILABLE` if the client can retry just the failing
    // call.
    //  (b) Use `ABORTED` if the client should retry at a higher level
    //      (e.g., when a client-specified test-and-set fails, indicating
    // the
    //      client should restart a read-modify-write sequence).
    //  (c) Use `FAILED_PRECONDITION` if the client should not retry until
    //      the system state has been explicitly fixed.  E.g., if an
    // "rmdir"
    //      fails because the directory is non-empty, `FAILED_PRECONDITION`
    //      should be returned since the client should not retry unless
    //      the files are deleted from the directory.
    //
    // HTTP Mapping: 400 Bad Request
    //   "ABORTED" - The operation was aborted, typically due to a
    // concurrency issue such as
    // a sequencer check failure or transaction abort.
    //
    // See the guidelines above for deciding between
    // `FAILED_PRECONDITION`,
    // `ABORTED`, and `UNAVAILABLE`.
    //
    // HTTP Mapping: 409 Conflict
    //   "OUT_OF_RANGE" - The operation was attempted past the valid range.
    // E.g., seeking or
    // reading past end-of-file.
    //
    // Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
    // be fixed if the system state changes. For example, a 32-bit
    // file
    // system will generate `INVALID_ARGUMENT` if asked to read at an
    // offset that is not in the range [0,2^32-1], but it will
    // generate
    // `OUT_OF_RANGE` if asked to read from an offset past the current
    // file size.
    //
    // There is a fair bit of overlap between `FAILED_PRECONDITION`
    // and
    // `OUT_OF_RANGE`.  We recommend using `OUT_OF_RANGE` (the more
    // specific
    // error) when it applies so that callers who are iterating through
    // a space can easily look for an `OUT_OF_RANGE` error to detect
    // when
    // they are done.
    //
    // HTTP Mapping: 400 Bad Request
    //   "UNIMPLEMENTED" - The operation is not implemented or is not
    // supported/enabled in this
    // service.
    //
    // HTTP Mapping: 501 Not Implemented
    //   "INTERNAL" - Internal errors.  This means that some invariants
    // expected by the
    // underlying system have been broken.  This error code is reserved
    // for serious errors.
    //
    // HTTP Mapping: 500 Internal Server Error
    //   "UNAVAILABLE" - The service is currently unavailable.  This is most
    // likely a
    // transient condition, which can be corrected by retrying with
    // a backoff.
    //
    // See the guidelines above for deciding between
    // `FAILED_PRECONDITION`,
    // `ABORTED`, and `UNAVAILABLE`.
    //
    // HTTP Mapping: 503 Service Unavailable
    //   "DATA_LOSS" - Unrecoverable data loss or corruption.
    //
    // HTTP Mapping: 500 Internal Server Error
    ErrorCode string `json:"errorCode,omitempty"`

    // ErrorCount: Count of this type of error.
    // Required.
    ErrorCount int64 `json:"errorCount,omitempty,string"`

    // ErrorLogEntries: Error samples.
    ErrorLogEntries []*ErrorLogEntry `json:"errorLogEntries,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ErrorCode") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ErrorCode") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ErrorSummary) MarshalJSON ¶

func (s *ErrorSummary) MarshalJSON() ([]byte, error)

type GcsData ¶

GcsData: 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.

type GcsData struct {
    // BucketName: Google Cloud Storage bucket name (see
    // [Bucket Name
    // Requirements](https://cloud.google.com/storage/docs/bucket-naming#requ
    // irements)).
    // Required.
    BucketName string `json:"bucketName,omitempty"`

    // ForceSendFields is a list of field names (e.g. "BucketName") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "BucketName") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*GcsData) MarshalJSON ¶

func (s *GcsData) MarshalJSON() ([]byte, error)

type GoogleServiceAccount ¶

GoogleServiceAccount: Google service account

type GoogleServiceAccount struct {
    // AccountEmail: Required.
    AccountEmail string `json:"accountEmail,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "AccountEmail") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AccountEmail") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*GoogleServiceAccount) MarshalJSON ¶

func (s *GoogleServiceAccount) MarshalJSON() ([]byte, error)

type GoogleServiceAccountsGetCall ¶

type GoogleServiceAccountsGetCall struct {
    // contains filtered or unexported fields
}

func (*GoogleServiceAccountsGetCall) Context ¶

func (c *GoogleServiceAccountsGetCall) Context(ctx context.Context) *GoogleServiceAccountsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GoogleServiceAccountsGetCall) Do ¶

func (c *GoogleServiceAccountsGetCall) Do(opts ...googleapi.CallOption) (*GoogleServiceAccount, error)

Do executes the "storagetransfer.googleServiceAccounts.get" call. Exactly one of *GoogleServiceAccount or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleServiceAccount.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GoogleServiceAccountsGetCall) Fields ¶

func (c *GoogleServiceAccountsGetCall) Fields(s ...googleapi.Field) *GoogleServiceAccountsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GoogleServiceAccountsGetCall) Header ¶

func (c *GoogleServiceAccountsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GoogleServiceAccountsGetCall) IfNoneMatch ¶

func (c *GoogleServiceAccountsGetCall) IfNoneMatch(entityTag string) *GoogleServiceAccountsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GoogleServiceAccountsService ¶

type GoogleServiceAccountsService struct {
    // contains filtered or unexported fields
}

func NewGoogleServiceAccountsService ¶

func NewGoogleServiceAccountsService(s *Service) *GoogleServiceAccountsService

func (*GoogleServiceAccountsService) Get ¶

func (r *GoogleServiceAccountsService) Get(projectId string) *GoogleServiceAccountsGetCall

Get: 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.

type HttpData ¶

HttpData: 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/#urls)

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

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

* If the specified size of an object does not match the actual size of the object fetched, the object 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#_sharin gdata) 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.

type HttpData struct {
    // ListUrl: 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 `json:"listUrl,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ListUrl") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ListUrl") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*HttpData) MarshalJSON ¶

func (s *HttpData) MarshalJSON() ([]byte, error)

type ListOperationsResponse ¶

ListOperationsResponse: The response message for Operations.ListOperations.

type ListOperationsResponse struct {
    // NextPageToken: The standard List next-page token.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // Operations: A list of operations that matches the specified filter in
    // the request.
    Operations []*Operation `json:"operations,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NextPageToken") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListOperationsResponse) MarshalJSON ¶

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListTransferJobsResponse ¶

ListTransferJobsResponse: Response from ListTransferJobs.

type ListTransferJobsResponse struct {
    // NextPageToken: The list next page token.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // TransferJobs: A list of transfer jobs.
    TransferJobs []*TransferJob `json:"transferJobs,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "NextPageToken") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NextPageToken") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ListTransferJobsResponse) MarshalJSON ¶

func (s *ListTransferJobsResponse) MarshalJSON() ([]byte, error)

type ObjectConditions ¶

ObjectConditions: Conditions that determine which objects will be transferred.

type ObjectConditions struct {
    // ExcludePrefixes: `excludePrefixes` must follow the requirements
    // described for
    // `includePrefixes`.
    //
    // The max size of `excludePrefixes` is 1000.
    ExcludePrefixes []string `json:"excludePrefixes,omitempty"`

    // IncludePrefixes: 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 `json:"includePrefixes,omitempty"`

    // MaxTimeElapsedSinceLastModification:
    // `maxTimeElapsedSinceLastModification` is the complement
    // to
    // `minTimeElapsedSinceLastModification`.
    MaxTimeElapsedSinceLastModification string `json:"maxTimeElapsedSinceLastModification,omitempty"`

    // MinTimeElapsedSinceLastModification: 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 string `json:"minTimeElapsedSinceLastModification,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ExcludePrefixes") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ExcludePrefixes") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*ObjectConditions) MarshalJSON ¶

func (s *ObjectConditions) MarshalJSON() ([]byte, error)

type Operation ¶

Operation: This resource represents a long-running operation that is the result of a network API call.

type Operation struct {
    // Done: If the value is `false`, it means the operation is still in
    // progress.
    // If true, the operation is completed, and either `error` or `response`
    // is
    // available.
    Done bool `json:"done,omitempty"`

    // Error: The error result of the operation in case of failure or
    // cancellation.
    Error *Status `json:"error,omitempty"`

    // Metadata: Represents the transfer operation object.
    Metadata googleapi.RawMessage `json:"metadata,omitempty"`

    // Name: The server-assigned name, which is only unique within the same
    // service that originally returns it. If you use the default HTTP
    // mapping, the `name` should have the format of
    // `transferOperations/some/unique/name`.
    Name string `json:"name,omitempty"`

    // Response: The normal response of the operation in case of success.
    // If the original
    // method returns no data on success, such as `Delete`, the response
    // is
    // `google.protobuf.Empty`.  If the original method is
    // standard
    // `Get`/`Create`/`Update`, the response should be the resource.  For
    // other
    // methods, the response should have the type `XxxResponse`, where
    // `Xxx`
    // is the original method name.  For example, if the original method
    // name
    // is `TakeSnapshot()`, the inferred response type
    // is
    // `TakeSnapshotResponse`.
    Response googleapi.RawMessage `json:"response,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Done") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Done") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Operation) MarshalJSON ¶

func (s *Operation) MarshalJSON() ([]byte, error)

type PauseTransferOperationRequest ¶

PauseTransferOperationRequest: Request passed to PauseTransferOperation.

type PauseTransferOperationRequest struct {
}

type ResumeTransferOperationRequest ¶

ResumeTransferOperationRequest: Request passed to ResumeTransferOperation.

type ResumeTransferOperationRequest struct {
}

type Schedule ¶

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

type Schedule struct {
    // ScheduleEndDate: 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 `json:"scheduleEndDate,omitempty"`

    // ScheduleStartDate: 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 `json:"scheduleStartDate,omitempty"`

    // StartTimeOfDay: 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 `json:"startTimeOfDay,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ScheduleEndDate") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ScheduleEndDate") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*Schedule) MarshalJSON ¶

func (s *Schedule) MarshalJSON() ([]byte, error)

type Service ¶

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    GoogleServiceAccounts *GoogleServiceAccountsService

    TransferJobs *TransferJobsService

    TransferOperations *TransferOperationsService
    // contains filtered or unexported fields
}

func New ¶

func New(client *http.Client) (*Service, error)

type Status ¶

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:

- Simple to use and understand for most users - Flexible enough to meet unexpected needs

# Overview

The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions.

# Language mapping

The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

# Other uses

The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

- Partial errors. If a service needs to return partial errors to the client,

it may embed the `Status` in the normal response to indicate the

partial

errors.

- Workflow errors. A typical workflow has multiple steps. Each step may

have a `Status` message for error reporting.

- Batch operations. If a client uses batch request and batch response, the

`Status` message should be used directly inside batch response,

one for

each error sub-response.

- Asynchronous operations. If an API call embeds asynchronous operation

results in its response, the status of those operations should

be

represented directly using the `Status` message.

- Logging. If some API errors are stored in logs, the message `Status` could

be used directly after any stripping needed for security/privacy

reasons.

type Status struct {
    // Code: The status code, which should be an enum value of
    // google.rpc.Code.
    Code int64 `json:"code,omitempty"`

    // Details: A list of messages that carry the error details.  There will
    // be a
    // common set of message types for APIs to use.
    Details []googleapi.RawMessage `json:"details,omitempty"`

    // Message: A developer-facing error message, which should be in
    // English. Any
    // user-facing error message should be localized and sent in
    // the
    // google.rpc.Status.details field, or localized by the client.
    Message string `json:"message,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Code") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Code") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Status) MarshalJSON ¶

func (s *Status) MarshalJSON() ([]byte, error)

type TimeOfDay ¶

TimeOfDay: Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.

type TimeOfDay struct {
    // Hours: Hours of day in 24 hour format. Should be from 0 to 23. An API
    // may choose
    // to allow the value "24:00:00" for scenarios like business closing
    // time.
    Hours int64 `json:"hours,omitempty"`

    // Minutes: Minutes of hour of day. Must be from 0 to 59.
    Minutes int64 `json:"minutes,omitempty"`

    // Nanos: Fractions of seconds in nanoseconds. Must be from 0 to
    // 999,999,999.
    Nanos int64 `json:"nanos,omitempty"`

    // Seconds: Seconds of minutes of the time. Must normally be from 0 to
    // 59. An API may
    // allow the value 60 if it allows leap-seconds.
    Seconds int64 `json:"seconds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Hours") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Hours") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*TimeOfDay) MarshalJSON ¶

func (s *TimeOfDay) MarshalJSON() ([]byte, error)

type TransferCounters ¶

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

type TransferCounters struct {
    // BytesCopiedToSink: Bytes that are copied to the data sink.
    BytesCopiedToSink int64 `json:"bytesCopiedToSink,omitempty,string"`

    // BytesDeletedFromSink: Bytes that are deleted from the data sink.
    BytesDeletedFromSink int64 `json:"bytesDeletedFromSink,omitempty,string"`

    // BytesDeletedFromSource: Bytes that are deleted from the data source.
    BytesDeletedFromSource int64 `json:"bytesDeletedFromSource,omitempty,string"`

    // BytesFailedToDeleteFromSink: Bytes that failed to be deleted from the
    // data sink.
    BytesFailedToDeleteFromSink int64 `json:"bytesFailedToDeleteFromSink,omitempty,string"`

    // BytesFoundFromSource: Bytes found in the data source that are
    // scheduled to be transferred,
    // which will be copied, excluded based on conditions, or skipped due
    // to
    // failures.
    BytesFoundFromSource int64 `json:"bytesFoundFromSource,omitempty,string"`

    // BytesFoundOnlyFromSink: Bytes found only in the data sink that are
    // scheduled to be deleted.
    BytesFoundOnlyFromSink int64 `json:"bytesFoundOnlyFromSink,omitempty,string"`

    // BytesFromSourceFailed: Bytes in the data source that failed during
    // the transfer.
    BytesFromSourceFailed int64 `json:"bytesFromSourceFailed,omitempty,string"`

    // BytesFromSourceSkippedBySync: Bytes in the data source that are not
    // transferred because they already
    // exist in the data sink.
    BytesFromSourceSkippedBySync int64 `json:"bytesFromSourceSkippedBySync,omitempty,string"`

    // ObjectsCopiedToSink: Objects that are copied to the data sink.
    ObjectsCopiedToSink int64 `json:"objectsCopiedToSink,omitempty,string"`

    // ObjectsDeletedFromSink: Objects that are deleted from the data sink.
    ObjectsDeletedFromSink int64 `json:"objectsDeletedFromSink,omitempty,string"`

    // ObjectsDeletedFromSource: Objects that are deleted from the data
    // source.
    ObjectsDeletedFromSource int64 `json:"objectsDeletedFromSource,omitempty,string"`

    // ObjectsFailedToDeleteFromSink: Objects that failed to be deleted from
    // the data sink.
    ObjectsFailedToDeleteFromSink int64 `json:"objectsFailedToDeleteFromSink,omitempty,string"`

    // ObjectsFoundFromSource: Objects found in the data source that are
    // scheduled to be transferred,
    // which will be copied, excluded based on conditions, or skipped due
    // to
    // failures.
    ObjectsFoundFromSource int64 `json:"objectsFoundFromSource,omitempty,string"`

    // ObjectsFoundOnlyFromSink: Objects found only in the data sink that
    // are scheduled to be deleted.
    ObjectsFoundOnlyFromSink int64 `json:"objectsFoundOnlyFromSink,omitempty,string"`

    // ObjectsFromSourceFailed: Objects in the data source that failed
    // during the transfer.
    ObjectsFromSourceFailed int64 `json:"objectsFromSourceFailed,omitempty,string"`

    // ObjectsFromSourceSkippedBySync: Objects in the data source that are
    // not transferred because they already
    // exist in the data sink.
    ObjectsFromSourceSkippedBySync int64 `json:"objectsFromSourceSkippedBySync,omitempty,string"`

    // ForceSendFields is a list of field names (e.g. "BytesCopiedToSink")
    // to unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "BytesCopiedToSink") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*TransferCounters) MarshalJSON ¶

func (s *TransferCounters) MarshalJSON() ([]byte, error)

type TransferJob ¶

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

type TransferJob struct {
    // CreationTime: This field cannot be changed by user requests.
    CreationTime string `json:"creationTime,omitempty"`

    // DeletionTime: This field cannot be changed by user requests.
    DeletionTime string `json:"deletionTime,omitempty"`

    // Description: A description provided by the user for the job. Its max
    // length is 1024
    // bytes when Unicode-encoded.
    Description string `json:"description,omitempty"`

    // LastModificationTime: This field cannot be changed by user requests.
    LastModificationTime string `json:"lastModificationTime,omitempty"`

    // Name: 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 `json:"name,omitempty"`

    // ProjectId: The ID of the Google Cloud Platform Console project that
    // owns the job.
    // Required.
    ProjectId string `json:"projectId,omitempty"`

    // Schedule: Schedule specification.
    // Required.
    Schedule *Schedule `json:"schedule,omitempty"`

    // Status: 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.
    //
    // Possible values:
    //   "STATUS_UNSPECIFIED" - Zero is an illegal value.
    //   "ENABLED" - New transfers will be performed based on the schedule.
    //   "DISABLED" - New transfers will not be scheduled.
    //   "DELETED" - 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.
    Status string `json:"status,omitempty"`

    // TransferSpec: Transfer specification.
    // Required.
    TransferSpec *TransferSpec `json:"transferSpec,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CreationTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CreationTime") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*TransferJob) MarshalJSON ¶

func (s *TransferJob) MarshalJSON() ([]byte, error)

type TransferJobsCreateCall ¶

type TransferJobsCreateCall struct {
    // contains filtered or unexported fields
}

func (*TransferJobsCreateCall) Context ¶

func (c *TransferJobsCreateCall) Context(ctx context.Context) *TransferJobsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferJobsCreateCall) Do ¶

func (c *TransferJobsCreateCall) Do(opts ...googleapi.CallOption) (*TransferJob, error)

Do executes the "storagetransfer.transferJobs.create" call. Exactly one of *TransferJob or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferJob.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferJobsCreateCall) Fields ¶

func (c *TransferJobsCreateCall) Fields(s ...googleapi.Field) *TransferJobsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferJobsCreateCall) Header ¶

func (c *TransferJobsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TransferJobsGetCall ¶

type TransferJobsGetCall struct {
    // contains filtered or unexported fields
}

func (*TransferJobsGetCall) Context ¶

func (c *TransferJobsGetCall) Context(ctx context.Context) *TransferJobsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferJobsGetCall) Do ¶

func (c *TransferJobsGetCall) Do(opts ...googleapi.CallOption) (*TransferJob, error)

Do executes the "storagetransfer.transferJobs.get" call. Exactly one of *TransferJob or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferJob.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferJobsGetCall) Fields ¶

func (c *TransferJobsGetCall) Fields(s ...googleapi.Field) *TransferJobsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferJobsGetCall) Header ¶

func (c *TransferJobsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*TransferJobsGetCall) IfNoneMatch ¶

func (c *TransferJobsGetCall) IfNoneMatch(entityTag string) *TransferJobsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*TransferJobsGetCall) ProjectId ¶

func (c *TransferJobsGetCall) ProjectId(projectId string) *TransferJobsGetCall

ProjectId sets the optional parameter "projectId": The ID of the Google Cloud Platform Console project that owns the job. Required.

type TransferJobsListCall ¶

type TransferJobsListCall struct {
    // contains filtered or unexported fields
}

func (*TransferJobsListCall) Context ¶

func (c *TransferJobsListCall) Context(ctx context.Context) *TransferJobsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferJobsListCall) Do ¶

func (c *TransferJobsListCall) Do(opts ...googleapi.CallOption) (*ListTransferJobsResponse, error)

Do executes the "storagetransfer.transferJobs.list" call. Exactly one of *ListTransferJobsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTransferJobsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferJobsListCall) Fields ¶

func (c *TransferJobsListCall) Fields(s ...googleapi.Field) *TransferJobsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferJobsListCall) Filter ¶

func (c *TransferJobsListCall) Filter(filter string) *TransferJobsListCall

Filter sets the optional parameter "filter": 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`.

func (*TransferJobsListCall) Header ¶

func (c *TransferJobsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*TransferJobsListCall) IfNoneMatch ¶

func (c *TransferJobsListCall) IfNoneMatch(entityTag string) *TransferJobsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*TransferJobsListCall) PageSize ¶

func (c *TransferJobsListCall) PageSize(pageSize int64) *TransferJobsListCall

PageSize sets the optional parameter "pageSize": The list page size. The max allowed value is 256.

func (*TransferJobsListCall) PageToken ¶

func (c *TransferJobsListCall) PageToken(pageToken string) *TransferJobsListCall

PageToken sets the optional parameter "pageToken": The list page token.

func (*TransferJobsListCall) Pages ¶

func (c *TransferJobsListCall) Pages(ctx context.Context, f func(*ListTransferJobsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type TransferJobsPatchCall ¶

type TransferJobsPatchCall struct {
    // contains filtered or unexported fields
}

func (*TransferJobsPatchCall) Context ¶

func (c *TransferJobsPatchCall) Context(ctx context.Context) *TransferJobsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferJobsPatchCall) Do ¶

func (c *TransferJobsPatchCall) Do(opts ...googleapi.CallOption) (*TransferJob, error)

Do executes the "storagetransfer.transferJobs.patch" call. Exactly one of *TransferJob or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TransferJob.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferJobsPatchCall) Fields ¶

func (c *TransferJobsPatchCall) Fields(s ...googleapi.Field) *TransferJobsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferJobsPatchCall) Header ¶

func (c *TransferJobsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TransferJobsService ¶

type TransferJobsService struct {
    // contains filtered or unexported fields
}

func NewTransferJobsService ¶

func NewTransferJobsService(s *Service) *TransferJobsService

func (*TransferJobsService) Create ¶

func (r *TransferJobsService) Create(transferjob *TransferJob) *TransferJobsCreateCall

Create: Creates a transfer job that runs periodically.

func (*TransferJobsService) Get ¶

func (r *TransferJobsService) Get(jobName string) *TransferJobsGetCall

Get: Gets a transfer job.

func (*TransferJobsService) List ¶

func (r *TransferJobsService) List() *TransferJobsListCall

List: Lists transfer jobs.

func (*TransferJobsService) Patch ¶

func (r *TransferJobsService) Patch(jobName string, updatetransferjobrequest *UpdateTransferJobRequest) *TransferJobsPatchCall

Patch: 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.

type TransferOperation ¶

TransferOperation: A description of the execution of a transfer.

type TransferOperation struct {
    // Counters: Information about the progress of the transfer operation.
    Counters *TransferCounters `json:"counters,omitempty"`

    // EndTime: End time of this transfer execution.
    EndTime string `json:"endTime,omitempty"`

    // ErrorBreakdowns: Summarizes errors encountered with sample error log
    // entries.
    ErrorBreakdowns []*ErrorSummary `json:"errorBreakdowns,omitempty"`

    // Name: A globally unique ID assigned by the system.
    Name string `json:"name,omitempty"`

    // ProjectId: The ID of the Google Cloud Platform Console project that
    // owns the operation.
    // Required.
    ProjectId string `json:"projectId,omitempty"`

    // StartTime: Start time of this transfer execution.
    StartTime string `json:"startTime,omitempty"`

    // Status: Status of the transfer operation.
    //
    // Possible values:
    //   "STATUS_UNSPECIFIED" - Zero is an illegal value.
    //   "IN_PROGRESS" - In progress.
    //   "PAUSED" - Paused.
    //   "SUCCESS" - Completed successfully.
    //   "FAILED" - Terminated due to an unrecoverable failure.
    //   "ABORTED" - Aborted by the user.
    Status string `json:"status,omitempty"`

    // TransferJobName: The name of the transfer job that triggers this
    // transfer operation.
    TransferJobName string `json:"transferJobName,omitempty"`

    // TransferSpec: Transfer specification.
    // Required.
    TransferSpec *TransferSpec `json:"transferSpec,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Counters") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Counters") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*TransferOperation) MarshalJSON ¶

func (s *TransferOperation) MarshalJSON() ([]byte, error)

type TransferOperationsCancelCall ¶

type TransferOperationsCancelCall struct {
    // contains filtered or unexported fields
}

func (*TransferOperationsCancelCall) Context ¶

func (c *TransferOperationsCancelCall) Context(ctx context.Context) *TransferOperationsCancelCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferOperationsCancelCall) Do ¶

func (c *TransferOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "storagetransfer.transferOperations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferOperationsCancelCall) Fields ¶

func (c *TransferOperationsCancelCall) Fields(s ...googleapi.Field) *TransferOperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferOperationsCancelCall) Header ¶

func (c *TransferOperationsCancelCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TransferOperationsDeleteCall ¶

type TransferOperationsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*TransferOperationsDeleteCall) Context ¶

func (c *TransferOperationsDeleteCall) Context(ctx context.Context) *TransferOperationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferOperationsDeleteCall) Do ¶

func (c *TransferOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "storagetransfer.transferOperations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferOperationsDeleteCall) Fields ¶

func (c *TransferOperationsDeleteCall) Fields(s ...googleapi.Field) *TransferOperationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferOperationsDeleteCall) Header ¶

func (c *TransferOperationsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TransferOperationsGetCall ¶

type TransferOperationsGetCall struct {
    // contains filtered or unexported fields
}

func (*TransferOperationsGetCall) Context ¶

func (c *TransferOperationsGetCall) Context(ctx context.Context) *TransferOperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferOperationsGetCall) Do ¶

func (c *TransferOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "storagetransfer.transferOperations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferOperationsGetCall) Fields ¶

func (c *TransferOperationsGetCall) Fields(s ...googleapi.Field) *TransferOperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferOperationsGetCall) Header ¶

func (c *TransferOperationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*TransferOperationsGetCall) IfNoneMatch ¶

func (c *TransferOperationsGetCall) IfNoneMatch(entityTag string) *TransferOperationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type TransferOperationsListCall ¶

type TransferOperationsListCall struct {
    // contains filtered or unexported fields
}

func (*TransferOperationsListCall) Context ¶

func (c *TransferOperationsListCall) Context(ctx context.Context) *TransferOperationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferOperationsListCall) Do ¶

func (c *TransferOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "storagetransfer.transferOperations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferOperationsListCall) Fields ¶

func (c *TransferOperationsListCall) Fields(s ...googleapi.Field) *TransferOperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferOperationsListCall) Filter ¶

func (c *TransferOperationsListCall) Filter(filter string) *TransferOperationsListCall

Filter sets the optional parameter "filter": A list of query parameters specified as JSON text in the form of {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\", \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...], \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.

func (*TransferOperationsListCall) Header ¶

func (c *TransferOperationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*TransferOperationsListCall) IfNoneMatch ¶

func (c *TransferOperationsListCall) IfNoneMatch(entityTag string) *TransferOperationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*TransferOperationsListCall) PageSize ¶

func (c *TransferOperationsListCall) PageSize(pageSize int64) *TransferOperationsListCall

PageSize sets the optional parameter "pageSize": The list page size. The max allowed value is 256.

func (*TransferOperationsListCall) PageToken ¶

func (c *TransferOperationsListCall) PageToken(pageToken string) *TransferOperationsListCall

PageToken sets the optional parameter "pageToken": The list page token.

func (*TransferOperationsListCall) Pages ¶

func (c *TransferOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type TransferOperationsPauseCall ¶

type TransferOperationsPauseCall struct {
    // contains filtered or unexported fields
}

func (*TransferOperationsPauseCall) Context ¶

func (c *TransferOperationsPauseCall) Context(ctx context.Context) *TransferOperationsPauseCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferOperationsPauseCall) Do ¶

func (c *TransferOperationsPauseCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "storagetransfer.transferOperations.pause" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferOperationsPauseCall) Fields ¶

func (c *TransferOperationsPauseCall) Fields(s ...googleapi.Field) *TransferOperationsPauseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferOperationsPauseCall) Header ¶

func (c *TransferOperationsPauseCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TransferOperationsResumeCall ¶

type TransferOperationsResumeCall struct {
    // contains filtered or unexported fields
}

func (*TransferOperationsResumeCall) Context ¶

func (c *TransferOperationsResumeCall) Context(ctx context.Context) *TransferOperationsResumeCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TransferOperationsResumeCall) Do ¶

func (c *TransferOperationsResumeCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "storagetransfer.transferOperations.resume" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TransferOperationsResumeCall) Fields ¶

func (c *TransferOperationsResumeCall) Fields(s ...googleapi.Field) *TransferOperationsResumeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TransferOperationsResumeCall) Header ¶

func (c *TransferOperationsResumeCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TransferOperationsService ¶

type TransferOperationsService struct {
    // contains filtered or unexported fields
}

func NewTransferOperationsService ¶

func NewTransferOperationsService(s *Service) *TransferOperationsService

func (*TransferOperationsService) Cancel ¶

func (r *TransferOperationsService) Cancel(name string) *TransferOperationsCancelCall

Cancel: Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.

func (*TransferOperationsService) Delete ¶

func (r *TransferOperationsService) Delete(name string) *TransferOperationsDeleteCall

Delete: This method is not supported and the server returns `UNIMPLEMENTED`.

func (*TransferOperationsService) Get ¶

func (r *TransferOperationsService) Get(name string) *TransferOperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

func (*TransferOperationsService) List ¶

func (r *TransferOperationsService) List(name string) *TransferOperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

func (*TransferOperationsService) Pause ¶

func (r *TransferOperationsService) Pause(name string, pausetransferoperationrequest *PauseTransferOperationRequest) *TransferOperationsPauseCall

Pause: Pauses a transfer operation.

func (*TransferOperationsService) Resume ¶

func (r *TransferOperationsService) Resume(name string, resumetransferoperationrequest *ResumeTransferOperationRequest) *TransferOperationsResumeCall

Resume: Resumes a transfer operation that is paused.

type TransferOptions ¶

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

type TransferOptions struct {
    // DeleteObjectsFromSourceAfterTransfer: Whether objects should be
    // deleted from the source after they are
    // transferred to the sink.
    DeleteObjectsFromSourceAfterTransfer bool `json:"deleteObjectsFromSourceAfterTransfer,omitempty"`

    // DeleteObjectsUniqueInSink: Whether objects that exist only in the
    // sink should be deleted.
    DeleteObjectsUniqueInSink bool `json:"deleteObjectsUniqueInSink,omitempty"`

    // OverwriteObjectsAlreadyExistingInSink: Whether overwriting objects
    // that already exist in the sink is allowed.
    OverwriteObjectsAlreadyExistingInSink bool `json:"overwriteObjectsAlreadyExistingInSink,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "DeleteObjectsFromSourceAfterTransfer") to unconditionally include in
    // API requests. By default, fields with empty values are omitted from
    // API requests. However, any non-pointer, non-interface field appearing
    // in ForceSendFields will be sent to the server regardless of whether
    // the field is empty or not. This may be used to include empty fields
    // in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g.
    // "DeleteObjectsFromSourceAfterTransfer") to include in API requests
    // with the JSON null value. By default, fields with empty values are
    // omitted from API requests. However, any field with an empty value
    // appearing in NullFields will be sent to the server as null. It is an
    // error if a field in this list has a non-empty value. This may be used
    // to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*TransferOptions) MarshalJSON ¶

func (s *TransferOptions) MarshalJSON() ([]byte, error)

type TransferSpec ¶

TransferSpec: Configuration for running a transfer.

type TransferSpec struct {
    // AwsS3DataSource: An AWS S3 data source.
    AwsS3DataSource *AwsS3Data `json:"awsS3DataSource,omitempty"`

    // GcsDataSink: A Google Cloud Storage data sink.
    GcsDataSink *GcsData `json:"gcsDataSink,omitempty"`

    // GcsDataSource: A Google Cloud Storage data source.
    GcsDataSource *GcsData `json:"gcsDataSource,omitempty"`

    // HttpDataSource: An HTTP URL data source.
    HttpDataSource *HttpData `json:"httpDataSource,omitempty"`

    // ObjectConditions: 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 `json:"objectConditions,omitempty"`

    // TransferOptions: 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 `json:"transferOptions,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AwsS3DataSource") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AwsS3DataSource") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*TransferSpec) MarshalJSON ¶

func (s *TransferSpec) MarshalJSON() ([]byte, error)

type UpdateTransferJobRequest ¶

UpdateTransferJobRequest: Request passed to UpdateTransferJob.

type UpdateTransferJobRequest struct {
    // ProjectId: The ID of the Google Cloud Platform Console project that
    // owns the job.
    // Required.
    ProjectId string `json:"projectId,omitempty"`

    // TransferJob: The job to update.
    // Required.
    TransferJob *TransferJob `json:"transferJob,omitempty"`

    // UpdateTransferJobFieldMask: 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 string `json:"updateTransferJobFieldMask,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ProjectId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ProjectId") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*UpdateTransferJobRequest) MarshalJSON ¶

func (s *UpdateTransferJobRequest) MarshalJSON() ([]byte, error)