generated/google/apis/cloudbuild_v1/service.rb in google-api-client-0.43.0 vs generated/google/apis/cloudbuild_v1/service.rb in google-api-client-0.44.0
- old
+ new
@@ -45,19 +45,17 @@
def initialize
super('https://cloudbuild.googleapis.com/', '')
@batch_path = 'batch'
end
- # Starts asynchronous cancellation on a long-running operation. The server
- # makes a best effort to cancel the operation, but success is not
- # guaranteed. If the server doesn't support this method, it returns
- # `google.rpc.Code.UNIMPLEMENTED`. Clients can use
- # Operations.GetOperation or
- # other methods to check whether the cancellation succeeded or whether the
- # operation completed despite cancellation. On successful cancellation,
- # the operation is not deleted; instead, it becomes an operation with
- # an Operation.error value with a google.rpc.Status.code of 1,
+ # Starts asynchronous cancellation on a long-running operation. The server makes
+ # a best effort to cancel the operation, but success is not guaranteed. If the
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ # Clients can use Operations.GetOperation or other methods to check whether the
+ # cancellation succeeded or whether the operation completed despite cancellation.
+ # On successful cancellation, the operation is not deleted; instead, it becomes
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
# corresponding to `Code.CANCELLED`.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::CloudbuildV1::CancelOperationRequest] cancel_operation_request_object
# @param [String] fields
@@ -87,13 +85,12 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.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.
+ # 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] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -155,14 +152,13 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Starts a build with the specified configuration.
- # This method returns a long-running `Operation`, which includes the build
- # ID. Pass the build ID to `GetBuild` to determine the build status (such as
- # `SUCCESS` or `FAILURE`).
+ # Starts a build with the specified configuration. This method returns a long-
+ # running `Operation`, which includes the build ID. Pass the build ID to `
+ # GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).
# @param [String] project_id
# Required. ID of the project.
# @param [Google::Apis::CloudbuildV1::Build] build_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -191,13 +187,13 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Returns information about a previously requested build.
- # The `Build` that is returned includes its status (such as `SUCCESS`,
- # `FAILURE`, or `WORKING`), and timing information.
+ # Returns information about a previously requested build. The `Build` that is
+ # returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and
+ # timing information.
# @param [String] project_id
# Required. ID of the project.
# @param [String] id
# Required. ID of the build.
# @param [String] fields
@@ -226,13 +222,12 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Lists previously requested builds.
- # Previously requested builds may still be in-progress, or may have finished
- # successfully or unsuccessfully.
+ # Lists previously requested builds. Previously requested builds may still be in-
+ # progress, or may have finished successfully or unsuccessfully.
# @param [String] project_id
# Required. ID of the project.
# @param [String] filter
# The raw filter text to constrain the results.
# @param [Fixnum] page_size
@@ -267,30 +262,26 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Creates a new build based on the specified build.
- # This method creates a new build using the original build request, which may
- # or may not result in an identical build.
- # For triggered builds:
- # * Triggered builds resolve to a precise revision; therefore a retry of a
- # triggered build will result in a build that uses the same revision.
- # For non-triggered builds that specify `RepoSource`:
- # * If the original build built from the tip of a branch, the retried build
- # will build from the tip of that branch, which may not be the same revision
- # as the original build.
- # * If the original build specified a commit sha or revision ID, the retried
- # build will use the identical source.
- # For builds that specify `StorageSource`:
- # * If the original build pulled source from Google Cloud Storage without
- # specifying the generation of the object, the new build will use the current
- # object, which may be different from the original build source.
+ # Creates a new build based on the specified build. This method creates a new
+ # build using the original build request, which may or may not result in an
+ # identical build. For triggered builds: * Triggered builds resolve to a precise
+ # revision; therefore a retry of a triggered build will result in a build that
+ # uses the same revision. For non-triggered builds that specify `RepoSource`: *
+ # If the original build built from the tip of a branch, the retried build will
+ # build from the tip of that branch, which may not be the same revision as the
+ # original build. * If the original build specified a commit sha or revision ID,
+ # the retried build will use the identical source. For builds that specify `
+ # StorageSource`: * If the original build pulled source from Google Cloud
+ # Storage without specifying the generation of the object, the new build will
+ # use the current object, which may be different from the original build source.
# * If the original build pulled source from Cloud Storage and specified the
- # generation of the object, the new build will attempt to use the same
- # object, which may or may not be available depending on the bucket's
- # lifecycle management settings.
+ # generation of the object, the new build will attempt to use the same object,
+ # which may or may not be available depending on the bucket's lifecycle
+ # management settings.
# @param [String] project_id
# Required. ID of the project.
# @param [String] id
# Required. Build ID of the original build.
# @param [Google::Apis::CloudbuildV1::RetryBuildRequest] retry_build_request_object
@@ -322,19 +313,17 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Starts asynchronous cancellation on a long-running operation. The server
- # makes a best effort to cancel the operation, but success is not
- # guaranteed. If the server doesn't support this method, it returns
- # `google.rpc.Code.UNIMPLEMENTED`. Clients can use
- # Operations.GetOperation or
- # other methods to check whether the cancellation succeeded or whether the
- # operation completed despite cancellation. On successful cancellation,
- # the operation is not deleted; instead, it becomes an operation with
- # an Operation.error value with a google.rpc.Status.code of 1,
+ # Starts asynchronous cancellation on a long-running operation. The server makes
+ # a best effort to cancel the operation, but success is not guaranteed. If the
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ # Clients can use Operations.GetOperation or other methods to check whether the
+ # cancellation succeeded or whether the operation completed despite cancellation.
+ # On successful cancellation, the operation is not deleted; instead, it becomes
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
# corresponding to `Code.CANCELLED`.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::CloudbuildV1::CancelOperationRequest] cancel_operation_request_object
# @param [String] fields
@@ -364,13 +353,12 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.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.
+ # 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] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -396,12 +384,11 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Creates a new `BuildTrigger`.
- # This API is experimental.
+ # Creates a new `BuildTrigger`. This API is experimental.
# @param [String] project_id
# Required. ID of the project for which to configure automatic builds.
# @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -430,12 +417,12 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Deletes a `BuildTrigger` by its project ID and trigger ID.
- # This API is experimental.
+ # Deletes a `BuildTrigger` by its project ID and trigger ID. This API is
+ # experimental.
# @param [String] project_id
# Required. ID of the project that owns the trigger.
# @param [String] trigger_id
# Required. ID of the `BuildTrigger` to delete.
# @param [String] fields
@@ -464,12 +451,11 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Returns information about a `BuildTrigger`.
- # This API is experimental.
+ # Returns information about a `BuildTrigger`. This API is experimental.
# @param [String] project_id
# Required. ID of the project that owns the trigger.
# @param [String] trigger_id
# Required. Identifier (`id` or `name`) of the `BuildTrigger` to get.
# @param [String] fields
@@ -498,12 +484,11 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Lists existing `BuildTrigger`s.
- # This API is experimental.
+ # Lists existing `BuildTrigger`s. This API is experimental.
# @param [String] project_id
# Required. ID of the project for which to list BuildTriggers.
# @param [Fixnum] page_size
# Number of results to return in the list.
# @param [String] page_token
@@ -535,11 +520,11 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
- # Updates a `BuildTrigger` by its project ID and trigger ID.
- # This API is experimental.
+ # Updates a `BuildTrigger` by its project ID and trigger ID. This API is
+ # experimental.
# @param [String] project_id
# Required. ID of the project that owns the trigger.
# @param [String] trigger_id
# Required. ID of the `BuildTrigger` to update.
# @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object