generated/google/apis/storagetransfer_v1/service.rb in google-api-client-0.29.1 vs generated/google/apis/storagetransfer_v1/service.rb in google-api-client-0.29.2
- old
+ new
@@ -55,13 +55,12 @@
# 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.
+ # Required. The ID of the Google Cloud Platform Console project that the
+ # Google service account is associated with.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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.
@@ -76,11 +75,11 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:get, 'v1/googleServiceAccounts/{projectId}', options)
+ 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['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -105,11 +104,11 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:post, 'v1/transferJobs', options)
+ 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['fields'] = fields unless fields.nil?
@@ -117,15 +116,14 @@
execute_or_queue_command(command, &block)
end
# Gets a transfer job.
# @param [String] job_name
- # The job to get.
- # Required.
+ # Required. The job to get.
# @param [String] project_id
- # The ID of the Google Cloud Platform Console project that owns the job.
- # Required.
+ # Required. The ID of the Google Cloud Platform Console project that owns the
+ # job.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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.
@@ -140,11 +138,11 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:get, 'v1/{+jobName}', options)
+ 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['fields'] = fields unless fields.nil?
@@ -152,11 +150,11 @@
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
+ # Required. 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.
@@ -182,11 +180,11 @@
#
# @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_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:get, 'v1/transferJobs', options)
+ 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['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
@@ -197,12 +195,11 @@
# 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.
+ # Required. The name of job to update.
# @param [Google::Apis::StoragetransferV1::UpdateTransferJobRequest] update_transfer_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -218,11 +215,11 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:patch, 'v1/{+jobName}', options)
+ 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?
@@ -251,11 +248,11 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:post, 'v1/{+name}:cancel', options)
+ 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['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -281,11 +278,11 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:delete, 'v1/{+name}', options)
+ 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['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -313,11 +310,11 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:get, 'v1/{+name}', options)
+ 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['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -332,18 +329,22 @@
# `"/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`.
+ # Required. The value `transferOperations`.
# @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.
+ # Required. 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. `project_id` is required. `
+ # job_names`, `operation_names`, and `transfer_statuses` are optional. The valid
+ # values for `transfer_statuses` are case-insensitive: `IN_PROGRESS`, `PAUSED`, `
+ # SUCCESS`, `FAILED`, and `ABORTED`.
# @param [Fixnum] page_size
# The list page size. The max allowed value is 256.
# @param [String] page_token
# The list page token.
# @param [String] fields
@@ -362,11 +363,11 @@
#
# @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, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:get, 'v1/{+name}', options)
+ 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['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
@@ -376,12 +377,11 @@
execute_or_queue_command(command, &block)
end
# Pauses a transfer operation.
# @param [String] name
- # The name of the transfer operation.
- # Required.
+ # Required. The name of the transfer operation.
# @param [Google::Apis::StoragetransferV1::PauseTransferOperationRequest] pause_transfer_operation_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -397,11 +397,11 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:post, 'v1/{+name}:pause', options)
+ 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?
@@ -410,12 +410,11 @@
execute_or_queue_command(command, &block)
end
# Resumes a transfer operation that is paused.
# @param [String] name
- # The name of the transfer operation.
- # Required.
+ # Required. The name of the transfer operation.
# @param [Google::Apis::StoragetransferV1::ResumeTransferOperationRequest] resume_transfer_operation_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -431,10 +430,10 @@
#
# @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, fields: nil, quota_user: nil, options: nil, &block)
- command = make_simple_command(:post, 'v1/{+name}:resume', options)
+ 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?