google-api-ruby-client/generated/google/apis/storagetransfer_v1/service.rb

457 lines
26 KiB
Ruby

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module StoragetransferV1
# Google Storage Transfer API
#
# Transfers data from external data sources to a Google Cloud Storage bucket or
# between Google Cloud Storage buckets.
#
# @example
# require 'google/apis/storagetransfer_v1'
#
# Storagetransfer = Google::Apis::StoragetransferV1 # Alias the module
# service = Storagetransfer::StoragetransferService.new
#
# @see https://cloud.google.com/storage/transfer
class StoragetransferService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://storagetransfer.googleapis.com/', '')
@batch_path = 'batch'
end
# 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.
# @param [String] project_id
# The ID of the Google Cloud Platform Console project that the Google service
# account is associated with.
# Required.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::GoogleServiceAccount] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::GoogleServiceAccount]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_google_service_account(project_id, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/googleServiceAccounts/{projectId}', options)
command.response_representation = Google::Apis::StoragetransferV1::GoogleServiceAccount::Representation
command.response_class = Google::Apis::StoragetransferV1::GoogleServiceAccount
command.params['projectId'] = project_id unless project_id.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Creates a transfer job that runs periodically.
# @param [Google::Apis::StoragetransferV1::TransferJob] transfer_job_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::TransferJob] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::TransferJob]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_transfer_job(transfer_job_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/transferJobs', options)
command.request_representation = Google::Apis::StoragetransferV1::TransferJob::Representation
command.request_object = transfer_job_object
command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation
command.response_class = Google::Apis::StoragetransferV1::TransferJob
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] job_name
# The name of job to update.
# Required.
# @param [Google::Apis::StoragetransferV1::UpdateTransferJobRequest] update_transfer_job_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::TransferJob] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::TransferJob]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_transfer_job(job_name, update_transfer_job_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+jobName}', options)
command.request_representation = Google::Apis::StoragetransferV1::UpdateTransferJobRequest::Representation
command.request_object = update_transfer_job_request_object
command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation
command.response_class = Google::Apis::StoragetransferV1::TransferJob
command.params['jobName'] = job_name unless job_name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Gets a transfer job.
# @param [String] job_name
# The job to get.
# Required.
# @param [String] project_id
# The ID of the Google Cloud Platform Console project that owns the job.
# Required.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::TransferJob] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::TransferJob]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_transfer_job(job_name, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+jobName}', options)
command.response_representation = Google::Apis::StoragetransferV1::TransferJob::Representation
command.response_class = Google::Apis::StoragetransferV1::TransferJob
command.params['jobName'] = job_name unless job_name.nil?
command.query['projectId'] = project_id unless project_id.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Lists transfer jobs.
# @param [String] 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`.
# @param [String] page_token
# The list page token.
# @param [Fixnum] page_size
# The list page size. The max allowed value is 256.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::ListTransferJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::ListTransferJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_transfer_jobs(filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/transferJobs', options)
command.response_representation = Google::Apis::StoragetransferV1::ListTransferJobsResponse::Representation
command.response_class = Google::Apis::StoragetransferV1::ListTransferJobsResponse
command.query['filter'] = filter unless filter.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# This method is not supported and the server returns `UNIMPLEMENTED`.
# @param [String] name
# The name of the operation resource to be deleted.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_transfer_operation(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation
command.response_class = Google::Apis::StoragetransferV1::Empty
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] name
# The value `transferOperations`.
# @param [String] page_token
# The list page token.
# @param [Fixnum] page_size
# The list page size. The max allowed value is 256.
# @param [String] 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.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::ListOperationsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_transfer_operations(name, page_token: nil, page_size: nil, filter: nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::StoragetransferV1::ListOperationsResponse::Representation
command.response_class = Google::Apis::StoragetransferV1::ListOperationsResponse
command.params['name'] = name unless name.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['filter'] = filter unless filter.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Resumes a transfer operation that is paused.
# @param [String] name
# The name of the transfer operation.
# Required.
# @param [Google::Apis::StoragetransferV1::ResumeTransferOperationRequest] resume_transfer_operation_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def resume_transfer_operation(name, resume_transfer_operation_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:resume', options)
command.request_representation = Google::Apis::StoragetransferV1::ResumeTransferOperationRequest::Representation
command.request_object = resume_transfer_operation_request_object
command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation
command.response_class = Google::Apis::StoragetransferV1::Empty
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Cancels a transfer. Use the get method to check whether the cancellation
# succeeded or whether the operation completed despite cancellation.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def cancel_transfer_operation(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation
command.response_class = Google::Apis::StoragetransferV1::Empty
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_transfer_operation(name, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::StoragetransferV1::Operation::Representation
command.response_class = Google::Apis::StoragetransferV1::Operation
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
# Pauses a transfer operation.
# @param [String] name
# The name of the transfer operation.
# Required.
# @param [Google::Apis::StoragetransferV1::PauseTransferOperationRequest] pause_transfer_operation_request_object
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::StoragetransferV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::StoragetransferV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def pause_transfer_operation(name, pause_transfer_operation_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:pause', options)
command.request_representation = Google::Apis::StoragetransferV1::PauseTransferOperationRequest::Representation
command.request_object = pause_transfer_operation_request_object
command.response_representation = Google::Apis::StoragetransferV1::Empty::Representation
command.response_class = Google::Apis::StoragetransferV1::Empty
command.params['name'] = name unless name.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end