google-cloud-orchestration-airflow-service-v1 1.0.1 → 1.2.0

data/lib/google/cloud/orchestration/airflow/service/v1/environments/rest/client.rb

@@ -159,8 +159,19 @@ module Google
                       endpoint: @config.endpoint,
                       endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                       universe_domain: @config.universe_domain,
-                      credentials: credentials
+                      credentials: credentials,
+                      logger: @config.logger
                     )
+
+                    @environments_stub.logger(stub: true)&.info do |entry|
+                      entry.set_system_name
+                      entry.set_service
+                      entry.message = "Created client for #{entry.service}"
+                      entry.set_credentials_fields credentials
+                      entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                      entry.set "defaultTimeout", @config.timeout if @config.timeout
+                      entry.set "quotaProject", @quota_project_id if @quota_project_id
+                    end
                   end
 
                   ##
@@ -170,6 +181,15 @@ module Google
                   #
                   attr_reader :operations_client
 
+                  ##
+                  # The logger used for request/response debug logging.
+                  #
+                  # @return [Logger]
+                  #
+                  def logger
+                    @environments_stub.logger
+                  end
+
                   # Service calls
 
                   ##
@@ -256,7 +276,7 @@ module Google
                     @environments_stub.create_environment request, options do |result, operation|
                       result = ::Gapic::Operation.new result, @operations_client, options: options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -336,7 +356,6 @@ module Google
 
                     @environments_stub.get_environment request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -425,7 +444,7 @@ module Google
                     @environments_stub.list_environments request, options do |result, operation|
                       result = ::Gapic::Rest::PagedEnumerable.new @environments_stub, :list_environments, "environments", request, result, options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -640,7 +659,7 @@ module Google
                     @environments_stub.update_environment request, options do |result, operation|
                       result = ::Gapic::Operation.new result, @operations_client, options: options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -728,7 +747,7 @@ module Google
                     @environments_stub.delete_environment request, options do |result, operation|
                       result = ::Gapic::Operation.new result, @operations_client, options: options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -817,7 +836,6 @@ module Google
 
                     @environments_stub.execute_airflow_command request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -906,7 +924,6 @@ module Google
 
                     @environments_stub.stop_airflow_command request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -994,7 +1011,6 @@ module Google
 
                     @environments_stub.poll_airflow_command request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1095,7 +1111,123 @@ module Google
                     @environments_stub.list_workloads request, options do |result, operation|
                       result = ::Gapic::Rest::PagedEnumerable.new @environments_stub, :list_workloads, "workloads", request, result, options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
+                    end
+                  rescue ::Gapic::Rest::Error => e
+                    raise ::Google::Cloud::Error.from_error(e)
+                  end
+
+                  ##
+                  # Check if an upgrade operation on the environment will succeed.
+                  #
+                  # In case of problems detailed info can be found in the returned Operation.
+                  #
+                  # @overload check_upgrade(request, options = nil)
+                  #   Pass arguments to `check_upgrade` via a request object, either of type
+                  #   {::Google::Cloud::Orchestration::Airflow::Service::V1::CheckUpgradeRequest} or an equivalent Hash.
+                  #
+                  #   @param request [::Google::Cloud::Orchestration::Airflow::Service::V1::CheckUpgradeRequest, ::Hash]
+                  #     A request object representing the call parameters. Required. To specify no
+                  #     parameters, or to keep all the default parameter values, pass an empty Hash.
+                  #   @param options [::Gapic::CallOptions, ::Hash]
+                  #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                  #
+                  # @overload check_upgrade(environment: nil, image_version: nil)
+                  #   Pass arguments to `check_upgrade` via keyword arguments. Note that at
+                  #   least one keyword argument is required. To specify no parameters, or to keep all
+                  #   the default parameter values, pass an empty Hash as a request object (see above).
+                  #
+                  #   @param environment [::String]
+                  #     Required. The resource name of the environment to check upgrade for, in the
+                  #     form:
+                  #     "projects/\\{projectId}/locations/\\{locationId}/environments/\\{environmentId}"
+                  #   @param image_version [::String]
+                  #     Optional. The version of the software running in the environment.
+                  #     This encapsulates both the version of Cloud Composer functionality and the
+                  #     version of Apache Airflow. It must match the regular expression
+                  #     `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`.
+                  #     When used as input, the server also checks if the provided version is
+                  #     supported and denies the request for an unsupported version.
+                  #
+                  #     The Cloud Composer portion of the image version is a full
+                  #     [semantic version](https://semver.org), or an alias in the form of major
+                  #     version number or `latest`. When an alias is provided, the server replaces
+                  #     it with the current Cloud Composer version that satisfies the alias.
+                  #
+                  #     The Apache Airflow portion of the image version is a full semantic version
+                  #     that points to one of the supported Apache Airflow versions, or an alias in
+                  #     the form of only major or major.minor versions specified. When an alias is
+                  #     provided, the server replaces it with the latest Apache Airflow version
+                  #     that satisfies the alias and is supported in the given Cloud Composer
+                  #     version.
+                  #
+                  #     In all cases, the resolved image version is stored in the same field.
+                  #
+                  #     See also [version
+                  #     list](/composer/docs/concepts/versioning/composer-versions) and [versioning
+                  #     overview](/composer/docs/concepts/versioning/composer-versioning-overview).
+                  # @yield [result, operation] Access the result along with the TransportOperation object
+                  # @yieldparam result [::Gapic::Operation]
+                  # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                  #
+                  # @return [::Gapic::Operation]
+                  #
+                  # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                  #
+                  # @example Basic example
+                  #   require "google/cloud/orchestration/airflow/service/v1"
+                  #
+                  #   # Create a client object. The client can be reused for multiple calls.
+                  #   client = Google::Cloud::Orchestration::Airflow::Service::V1::Environments::Rest::Client.new
+                  #
+                  #   # Create a request. To set request fields, pass in keyword arguments.
+                  #   request = Google::Cloud::Orchestration::Airflow::Service::V1::CheckUpgradeRequest.new
+                  #
+                  #   # Call the check_upgrade method.
+                  #   result = client.check_upgrade request
+                  #
+                  #   # The returned object is of type Gapic::Operation. You can use it to
+                  #   # check the status of an operation, cancel it, or wait for results.
+                  #   # Here is how to wait for a response.
+                  #   result.wait_until_done! timeout: 60
+                  #   if result.response?
+                  #     p result.response
+                  #   else
+                  #     puts "No response received."
+                  #   end
+                  #
+                  def check_upgrade request, options = nil
+                    raise ::ArgumentError, "request must be provided" if request.nil?
+
+                    request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Orchestration::Airflow::Service::V1::CheckUpgradeRequest
+
+                    # Converts hash and nil to an options object
+                    options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                    # Customize the options with defaults
+                    call_metadata = @config.rpcs.check_upgrade.metadata.to_h
+
+                    # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                    call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                      lib_name: @config.lib_name, lib_version: @config.lib_version,
+                      gapic_version: ::Google::Cloud::Orchestration::Airflow::Service::V1::VERSION,
+                      transports_version_send: [:rest]
+
+                    call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                    call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                    options.apply_defaults timeout:      @config.rpcs.check_upgrade.timeout,
+                                           metadata:     call_metadata,
+                                           retry_policy: @config.rpcs.check_upgrade.retry_policy
+
+                    options.apply_defaults timeout:      @config.timeout,
+                                           metadata:     @config.metadata,
+                                           retry_policy: @config.retry_policy
+
+                    @environments_stub.check_upgrade request, options do |result, operation|
+                      result = ::Gapic::Operation.new result, @operations_client, options: options
+                      yield result, operation if block_given?
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1180,7 +1312,6 @@ module Google
 
                     @environments_stub.create_user_workloads_secret request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1264,7 +1395,6 @@ module Google
 
                     @environments_stub.get_user_workloads_secret request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1357,7 +1487,7 @@ module Google
                     @environments_stub.list_user_workloads_secrets request, options do |result, operation|
                       result = ::Gapic::Rest::PagedEnumerable.new @environments_stub, :list_user_workloads_secrets, "user_workloads_secrets", request, result, options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1439,7 +1569,6 @@ module Google
 
                     @environments_stub.update_user_workloads_secret request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1522,7 +1651,6 @@ module Google
 
                     @environments_stub.delete_user_workloads_secret request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1607,7 +1735,6 @@ module Google
 
                     @environments_stub.create_user_workloads_config_map request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1690,7 +1817,6 @@ module Google
 
                     @environments_stub.get_user_workloads_config_map request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1783,7 +1909,7 @@ module Google
                     @environments_stub.list_user_workloads_config_maps request, options do |result, operation|
                       result = ::Gapic::Rest::PagedEnumerable.new @environments_stub, :list_user_workloads_config_maps, "user_workloads_config_maps", request, result, options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1865,7 +1991,6 @@ module Google
 
                     @environments_stub.update_user_workloads_config_map request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -1948,7 +2073,6 @@ module Google
 
                     @environments_stub.delete_user_workloads_config_map request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -2042,7 +2166,7 @@ module Google
                     @environments_stub.save_snapshot request, options do |result, operation|
                       result = ::Gapic::Operation.new result, @operations_client, options: options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -2148,7 +2272,7 @@ module Google
                     @environments_stub.load_snapshot request, options do |result, operation|
                       result = ::Gapic::Operation.new result, @operations_client, options: options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -2236,7 +2360,7 @@ module Google
                     @environments_stub.database_failover request, options do |result, operation|
                       result = ::Gapic::Operation.new result, @operations_client, options: options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -2316,7 +2440,6 @@ module Google
 
                     @environments_stub.fetch_database_properties request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -2396,6 +2519,11 @@ module Google
                   #   default endpoint URL. The default value of nil uses the environment
                   #   universe (usually the default "googleapis.com" universe).
                   #   @return [::String,nil]
+                  # @!attribute [rw] logger
+                  #   A custom logger to use for request/response debug logging, or the value
+                  #   `:default` (the default) to construct a default logger, or `nil` to
+                  #   explicitly disable logging.
+                  #   @return [::Logger,:default,nil]
                   #
                   class Configuration
                     extend ::Gapic::Config
@@ -2417,6 +2545,7 @@ module Google
                     config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                     config_attr :quota_project, nil, ::String, nil
                     config_attr :universe_domain, nil, ::String, nil
+                    config_attr :logger, :default, ::Logger, nil, :default
 
                     # @private
                     def initialize parent_config = nil
@@ -2501,6 +2630,11 @@ module Google
                       #
                       attr_reader :list_workloads
                       ##
+                      # RPC-specific configuration for `check_upgrade`
+                      # @return [::Gapic::Config::Method]
+                      #
+                      attr_reader :check_upgrade
+                      ##
                       # RPC-specific configuration for `create_user_workloads_secret`
                       # @return [::Gapic::Config::Method]
                       #
@@ -2591,6 +2725,8 @@ module Google
                         @poll_airflow_command = ::Gapic::Config::Method.new poll_airflow_command_config
                         list_workloads_config = parent_rpcs.list_workloads if parent_rpcs.respond_to? :list_workloads
                         @list_workloads = ::Gapic::Config::Method.new list_workloads_config
+                        check_upgrade_config = parent_rpcs.check_upgrade if parent_rpcs.respond_to? :check_upgrade
+                        @check_upgrade = ::Gapic::Config::Method.new check_upgrade_config
                         create_user_workloads_secret_config = parent_rpcs.create_user_workloads_secret if parent_rpcs.respond_to? :create_user_workloads_secret
                         @create_user_workloads_secret = ::Gapic::Config::Method.new create_user_workloads_secret_config
                         get_user_workloads_secret_config = parent_rpcs.get_user_workloads_secret if parent_rpcs.respond_to? :get_user_workloads_secret

data/lib/google/cloud/orchestration/airflow/service/v1/environments/rest/operations.rb

@@ -117,14 +117,6 @@ module Google
                   # 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.
-                  #
                   # @overload list_operations(request, options = nil)
                   #   Pass arguments to `list_operations` via a request object, either of type
                   #   {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -206,7 +198,7 @@ module Google
                     @operations_stub.list_operations request, options do |result, operation|
                       result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -295,7 +287,7 @@ module Google
                     @operations_stub.get_operation request, options do |result, operation|
                       result = ::Gapic::Operation.new result, @operations_client, options: options
                       yield result, operation if block_given?
-                      return result
+                      throw :response, result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -377,7 +369,6 @@ module Google
 
                     @operations_stub.delete_operation request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -392,8 +383,9 @@ module Google
                   # 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 {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
-                  # corresponding to `Code.CANCELLED`.
+                  # an {::Google::Longrunning::Operation#error Operation.error} value with a
+                  # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
+                  # `Code.CANCELLED`.
                   #
                   # @overload cancel_operation(request, options = nil)
                   #   Pass arguments to `cancel_operation` via a request object, either of type
@@ -465,7 +457,6 @@ module Google
 
                     @operations_stub.cancel_operation request, options do |result, operation|
                       yield result, operation if block_given?
-                      return result
                     end
                   rescue ::Gapic::Rest::Error => e
                     raise ::Google::Cloud::Error.from_error(e)
@@ -545,6 +536,11 @@ module Google
                   #   default endpoint URL. The default value of nil uses the environment
                   #   universe (usually the default "googleapis.com" universe).
                   #   @return [::String,nil]
+                  # @!attribute [rw] logger
+                  #   A custom logger to use for request/response debug logging, or the value
+                  #   `:default` (the default) to construct a default logger, or `nil` to
+                  #   explicitly disable logging.
+                  #   @return [::Logger,:default,nil]
                   #
                   class Configuration
                     extend ::Gapic::Config
@@ -566,6 +562,7 @@ module Google
                     config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                     config_attr :quota_project, nil, ::String, nil
                     config_attr :universe_domain, nil, ::String, nil
+                    config_attr :logger, :default, ::Logger, nil, :default
 
                     # @private
                     def initialize parent_config = nil
@@ -685,16 +682,18 @@ module Google
 
                     response = @client_stub.make_http_request(
                       verb,
-                      uri:     uri,
-                      body:    body || "",
-                      params:  query_string_params,
+                      uri: uri,
+                      body: body || "",
+                      params: query_string_params,
+                      method_name: "list_operations",
                       options: options
                     )
                     operation = ::Gapic::Rest::TransportOperation.new response
                     result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                    yield result, operation if block_given?
-                    result
+                    catch :response do
+                      yield result, operation if block_given?
+                      result
+                    end
                   end
 
                   ##
@@ -723,16 +722,18 @@ module Google
 
                     response = @client_stub.make_http_request(
                       verb,
-                      uri:     uri,
-                      body:    body || "",
-                      params:  query_string_params,
+                      uri: uri,
+                      body: body || "",
+                      params: query_string_params,
+                      method_name: "get_operation",
                       options: options
                     )
                     operation = ::Gapic::Rest::TransportOperation.new response
                     result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                    yield result, operation if block_given?
-                    result
+                    catch :response do
+                      yield result, operation if block_given?
+                      result
+                    end
                   end
 
                   ##
@@ -761,16 +762,18 @@ module Google
 
                     response = @client_stub.make_http_request(
                       verb,
-                      uri:     uri,
-                      body:    body || "",
-                      params:  query_string_params,
+                      uri: uri,
+                      body: body || "",
+                      params: query_string_params,
+                      method_name: "delete_operation",
                       options: options
                     )
                     operation = ::Gapic::Rest::TransportOperation.new response
                     result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                    yield result, operation if block_given?
-                    result
+                    catch :response do
+                      yield result, operation if block_given?
+                      result
+                    end
                   end
 
                   ##
@@ -799,16 +802,18 @@ module Google
 
                     response = @client_stub.make_http_request(
                       verb,
-                      uri:     uri,
-                      body:    body || "",
-                      params:  query_string_params,
+                      uri: uri,
+                      body: body || "",
+                      params: query_string_params,
+                      method_name: "cancel_operation",
                       options: options
                     )
                     operation = ::Gapic::Rest::TransportOperation.new response
                     result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                    yield result, operation if block_given?
-                    result
+                    catch :response do
+                      yield result, operation if block_given?
+                      result
+                    end
                   end
 
                   ##