lib/google/apis/clouddeploy_v1/service.rb in google-apis-clouddeploy_v1-0.37.0 vs lib/google/apis/clouddeploy_v1/service.rb in google-apis-clouddeploy_v1-0.38.0

- old
+ new

@@ -30,10 +30,12 @@ # Clouddeploy = Google::Apis::ClouddeployV1 # Alias the module # service = Clouddeploy::CloudDeployService.new # # @see https://cloud.google.com/deploy/ class CloudDeployService < Google::Apis::Core::BaseService + DEFAULT_ENDPOINT_TEMPLATE = "https://clouddeploy.$UNIVERSE_DOMAIN$/" + # @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 @@ -41,11 +43,11 @@ # 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://clouddeploy.googleapis.com/', '', + super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-clouddeploy_v1', client_version: Google::Apis::ClouddeployV1::GEM_VERSION) @batch_path = 'batch' end @@ -153,23 +155,23 @@ end # Creates a new CustomTargetType in a given project and location. # @param [String] parent # Required. The parent collection in which the `CustomTargetType` should be - # created in. Format should be `projects/`project_id`/locations/`location_name``. + # created. Format should be `projects/`project_id`/locations/`location_name``. # @param [Google::Apis::ClouddeployV1::CustomTargetType] custom_target_type_object # @param [String] custom_target_type_id # Required. ID of the `CustomTargetType`. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [Boolean] validate_only # Optional. If set to true, the request is validated and the user is provided # with an expected result, but no actual change is made. @@ -217,17 +219,17 @@ # Optional. This checksum is computed by the server based on the value of other # fields, and may be sent on update and delete requests to ensure the client has # an up-to-date value before proceeding. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes after the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [Boolean] validate_only # Optional. If set to true, the request is validated but no actual change is # made. @@ -351,25 +353,25 @@ # @param [Boolean] allow_missing # Optional. If set to true, updating a `CustomTargetType` that does not exist # will result in the creation of a new `CustomTargetType`. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [String] update_mask # Required. Field mask is used to specify the fields to be overwritten in the ` # CustomTargetType` resource by the update. The fields specified in the # update_mask are relative to the resource, not the full request. A field will - # be overwritten if it is in the mask. If the user does not provide a mask then - # all fields will be overwritten. + # be overwritten if it's in the mask. If the user doesn't provide a mask then + # all fields are overwritten. # @param [Boolean] validate_only # Optional. If set to true, the request is validated and the user is provided # with an expected result, but no actual change is made. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -411,17 +413,17 @@ # @param [Google::Apis::ClouddeployV1::DeliveryPipeline] delivery_pipeline_object # @param [String] delivery_pipeline_id # Required. ID of the `DeliveryPipeline`. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [Boolean] validate_only # Optional. If set to true, the request is validated and the user is provided # with an expected result, but no actual change is made. @@ -473,17 +475,17 @@ # Optional. If set to true, all child resources under this pipeline will also be # deleted. Otherwise, the request will only work if the pipeline has no child # resources. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes after the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [Boolean] validate_only # Optional. If set, validate the request and preview the review, but do not # actually post it. @@ -651,25 +653,25 @@ # @param [Boolean] allow_missing # Optional. If set to true, updating a `DeliveryPipeline` that does not exist # will result in the creation of a new `DeliveryPipeline`. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [String] update_mask # Required. Field mask is used to specify the fields to be overwritten in the ` # DeliveryPipeline` resource by the update. The fields specified in the # update_mask are relative to the resource, not the full request. A field will - # be overwritten if it is in the mask. If the user does not provide a mask then - # all fields will be overwritten. + # be overwritten if it's in the mask. If the user doesn't provide a mask then + # all fields are overwritten. # @param [Boolean] validate_only # Optional. If set to true, the request is validated and the user is provided # with an expected result, but no actual change is made. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -941,17 +943,17 @@ # @param [Google::Apis::ClouddeployV1::Automation] automation_object # @param [String] automation_id # Required. ID of the `Automation`. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [Boolean] validate_only # Optional. If set to true, the request is validated and the user is provided # with an expected result, but no actual change is made. @@ -999,17 +1001,17 @@ # Optional. The weak etag of the request. This checksum is computed by the # server based on the value of other fields, and may be sent on update and # delete requests to ensure the client has an up-to-date value before proceeding. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes after the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [Boolean] validate_only # Optional. If set, validate the request and verify whether the resource exists, # but do not actually post it. @@ -1132,25 +1134,25 @@ # @param [Boolean] allow_missing # Optional. If set to true, updating a `Automation` that does not exist will # result in the creation of a new `Automation`. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [String] update_mask # Required. Field mask is used to specify the fields to be overwritten in the ` # Automation` resource by the update. The fields specified in the update_mask # are relative to the resource, not the full request. A field will be - # overwritten if it is in the mask. If the user does not provide a mask then all - # fields will be overwritten. + # overwritten if it's in the mask. If the user doesn't provide a mask then all + # fields are overwritten. # @param [Boolean] validate_only # Optional. If set to true, the request is validated and the user is provided # with an expected result, but no actual change is made. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1227,17 +1229,17 @@ # @param [Google::Apis::ClouddeployV1::Release] release_object # @param [String] release_id # Required. ID of the `Release`. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [Boolean] validate_only # Optional. If set to true, the request is validated and the user is provided # with an expected result, but no actual change is made. @@ -1466,17 +1468,17 @@ # Format should be `projects/`project_id`/locations/`location_name`/ # deliveryPipelines/`pipeline_name`/releases/`release_name``. # @param [Google::Apis::ClouddeployV1::Rollout] rollout_object # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [String] rollout_id # Required. ID of the `Rollout`. # @param [String] starting_phase_id @@ -1933,17 +1935,17 @@ # Required. The parent collection in which the `Target` should be created. # Format should be `projects/`project_id`/locations/`location_name``. # @param [Google::Apis::ClouddeployV1::Target] target_object # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [String] target_id # Required. ID of the `Target`. # @param [Boolean] validate_only @@ -1992,17 +1994,17 @@ # Optional. This checksum is computed by the server based on the value of other # fields, and may be sent on update and delete requests to ensure the client has # an up-to-date value before proceeding. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes after the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [Boolean] validate_only # Optional. If set, validate the request and preview the review, but do not # actually post it. @@ -2170,23 +2172,23 @@ # @param [Boolean] allow_missing # Optional. If set to true, updating a `Target` that does not exist will result # in the creation of a new `Target`. # @param [String] request_id # Optional. A request ID to identify requests. Specify a unique request ID so - # that if you must retry your request, the server will know to ignore the - # request if it has already been completed. The server will guarantee that for - # at least 60 minutes since the first request. For example, consider a situation - # where you make an initial request and the request times out. If you make the - # request again with the same request ID, the server can check if original - # operation with the same request ID was received, and if so, will ignore the - # second request. This prevents clients from accidentally creating duplicate + # that if you must retry your request, the server knows to ignore the request if + # it has already been completed. The server guarantees that for at least 60 + # minutes after the first request. For example, consider a situation where you + # make an initial request and the request times out. If you make the request + # again with the same request ID, the server can check if original operation + # with the same request ID was received, and if so, will ignore the second + # request. This prevents clients from accidentally creating duplicate # commitments. The request ID must be a valid UUID with the exception that zero # UUID is not supported (00000000-0000-0000-0000-000000000000). # @param [String] update_mask # Required. Field mask is used to specify the fields to be overwritten in the # Target resource by the update. The fields specified in the update_mask are # relative to the resource, not the full request. A field will be overwritten if - # it is in the mask. If the user does not provide a mask then all fields will be + # it's in the mask. If the user doesn't provide a mask then all fields are # overwritten. # @param [Boolean] validate_only # Optional. If set to true, the request is validated and the user is provided # with an expected result, but no actual change is made. # @param [String] fields