google-cloud-workstations-v1beta 0.8.1 → 0.10.0

data/lib/google/cloud/workstations/v1beta/workstations/rest/client.rb

@@ -381,7 +381,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload list_workstation_clusters(parent: nil, page_size: nil, page_token: nil)
+              # @overload list_workstation_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil)
               #   Pass arguments to `list_workstation_clusters` 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).
@@ -393,6 +393,9 @@ module Google
               #   @param page_token [::String]
               #     Optional. next_page_token value returned from a previous List request, if
               #     any.
+              #   @param filter [::String]
+              #     Optional. Filter the WorkstationClusters to be listed. Possible filters are
+              #     described in https://google.aip.dev/160.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Workstations::V1beta::WorkstationCluster>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -482,7 +485,7 @@ module Google
               #   @param workstation_cluster [::Google::Cloud::Workstations::V1beta::WorkstationCluster, ::Hash]
               #     Required. Workstation cluster to create.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
@@ -575,7 +578,7 @@ module Google
               #     Required. Mask that specifies which fields in the workstation cluster
               #     should be updated.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               #   @param allow_missing [::Boolean]
               #     Optional. If set, and the workstation cluster is not found, a new
@@ -669,7 +672,7 @@ module Google
               #   @param name [::String]
               #     Required. Name of the workstation cluster to delete.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     apply it.
               #   @param etag [::String]
               #     Optional. If set, the request will be rejected if the latest version of the
@@ -836,7 +839,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload list_workstation_configs(parent: nil, page_size: nil, page_token: nil)
+              # @overload list_workstation_configs(parent: nil, page_size: nil, page_token: nil, filter: nil)
               #   Pass arguments to `list_workstation_configs` 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).
@@ -848,6 +851,9 @@ module Google
               #   @param page_token [::String]
               #     Optional. next_page_token value returned from a previous List request, if
               #     any.
+              #   @param filter [::String]
+              #     Optional. Filter the WorkstationConfigs to be listed. Possible filters are
+              #     described in https://google.aip.dev/160.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Workstations::V1beta::WorkstationConfig>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1025,9 +1031,9 @@ module Google
               #   @param workstation_config_id [::String]
               #     Required. ID to use for the workstation configuration.
               #   @param workstation_config [::Google::Cloud::Workstations::V1beta::WorkstationConfig, ::Hash]
-              #     Required. Config to create.
+              #     Required. Workstation configuration to create.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
@@ -1115,12 +1121,12 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param workstation_config [::Google::Cloud::Workstations::V1beta::WorkstationConfig, ::Hash]
-              #     Required. Config to update.
+              #     Required. Workstation configuration to update.
               #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
               #     Required. Mask specifying which fields in the workstation configuration
               #     should be updated.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               #   @param allow_missing [::Boolean]
               #     Optional. If set and the workstation configuration is not found, a new
@@ -1214,7 +1220,7 @@ module Google
               #   @param name [::String]
               #     Required. Name of the workstation configuration to delete.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               #   @param etag [::String]
               #     Optional. If set, the request is rejected if the latest version of the
@@ -1381,7 +1387,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload list_workstations(parent: nil, page_size: nil, page_token: nil)
+              # @overload list_workstations(parent: nil, page_size: nil, page_token: nil, filter: nil)
               #   Pass arguments to `list_workstations` 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).
@@ -1393,6 +1399,9 @@ module Google
               #   @param page_token [::String]
               #     Optional. next_page_token value returned from a previous List request, if
               #     any.
+              #   @param filter [::String]
+              #     Optional. Filter the Workstations to be listed. Possible filters are
+              #     described in https://google.aip.dev/160.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Workstations::V1beta::Workstation>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1570,9 +1579,13 @@ module Google
               #   @param workstation_id [::String]
               #     Required. ID to use for the workstation.
               #   @param workstation [::Google::Cloud::Workstations::V1beta::Workstation, ::Hash]
-              #     Required. Workstation to create.
+              #     Required. Workstation to create. If source_workstation is specified, the
+              #     user must have `workstations.workstations.use` permission on the source
+              #     workstation, and the Cloud Workstations Service Agent for the project where
+              #     you are creating the new workstation must have compute.disks.createSnapshot
+              #     and compute.snapshots.useReadOnly on the source project.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
@@ -1662,15 +1675,14 @@ module Google
               #   @param workstation [::Google::Cloud::Workstations::V1beta::Workstation, ::Hash]
               #     Required. Workstation to update.
               #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-              #     Required. Mask specifying which fields in the workstation configuration
-              #     should be updated.
+              #     Required. Mask specifying which fields in the workstation should be
+              #     updated.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               #   @param allow_missing [::Boolean]
-              #     Optional. If set and the workstation configuration is not found, a new
-              #     workstation configuration is created. In this situation, update_mask
-              #     is ignored.
+              #     Optional. If set and the workstation is not found, a new workstation is
+              #     created. In this situation, update_mask is ignored.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1759,7 +1771,7 @@ module Google
               #   @param name [::String]
               #     Required. Name of the workstation to delete.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               #   @param etag [::String]
               #     Optional. If set, the request will be rejected if the latest version of the
@@ -1844,7 +1856,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload start_workstation(name: nil, validate_only: nil, etag: nil)
+              # @overload start_workstation(name: nil, validate_only: nil, etag: nil, boost_config: nil)
               #   Pass arguments to `start_workstation` 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).
@@ -1852,11 +1864,14 @@ module Google
               #   @param name [::String]
               #     Required. Name of the workstation to start.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               #   @param etag [::String]
               #     Optional. If set, the request will be rejected if the latest version of the
               #     workstation on the server does not have this ETag.
+              #   @param boost_config [::String]
+              #     Optional. If set, the workstation starts using the boost configuration with
+              #     the specified ID.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1945,7 +1960,7 @@ module Google
               #   @param name [::String]
               #     Required. Name of the workstation to stop.
               #   @param validate_only [::Boolean]
-              #     Optional. If set, validate the request and preview the review, but do not
+              #     Optional. If set, validate the request and preview the result, but do not
               #     actually apply it.
               #   @param etag [::String]
               #     Optional. If set, the request will be rejected if the latest version of the
@@ -2020,6 +2035,8 @@ module Google
               ##
               # Returns a short-lived credential that can be used to send authenticated and
               # authorized traffic to a workstation.
+              # Once generated this token cannot be revoked and is good for the lifetime
+              # of the token.
               #
               # @overload generate_access_token(request, options = nil)
               #   Pass arguments to `generate_access_token` via a request object, either of type
@@ -2031,7 +2048,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload generate_access_token(expire_time: nil, ttl: nil, workstation: nil)
+              # @overload generate_access_token(expire_time: nil, ttl: nil, workstation: nil, port: nil)
               #   Pass arguments to `generate_access_token` 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).
@@ -2052,6 +2069,12 @@ module Google
               #   @param workstation [::String]
               #     Required. Name of the workstation for which the access token should be
               #     generated.
+              #   @param port [::Integer]
+              #     Optional. Port for which the access token should be generated. If
+              #     specified, the generated access token grants access only to the
+              #     specified port of the workstation. If specified, values must be within the
+              #     range [1 - 65535]. If not specified, the generated access token grants
+              #     access to all ports of the workstation.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Workstations::V1beta::GenerateAccessTokenResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2110,6 +2133,100 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Pushes credentials to a running workstation on behalf of a user. Once
+              # complete, supported credential types (application_default_credentials) are
+              # made available to processes running in the user container.
+              #
+              # @overload push_credentials(request, options = nil)
+              #   Pass arguments to `push_credentials` via a request object, either of type
+              #   {::Google::Cloud::Workstations::V1beta::PushCredentialsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Workstations::V1beta::PushCredentialsRequest, ::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 push_credentials(workstation: nil, application_default_credentials: nil)
+              #   Pass arguments to `push_credentials` 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 workstation [::String]
+              #     Required. Name of the workstation for which the credentials should be
+              #     pushed.
+              #   @param application_default_credentials [::Google::Cloud::Workstations::V1beta::PushCredentialsRequest::OAuthToken, ::Hash]
+              #     Optional. Credentials used by Cloud Client Libraries, Google API Client
+              #     Libraries, and other tooling within the user conainer:
+              #     https://cloud.google.com/docs/authentication/application-default-credentials
+              # @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/workstations/v1beta"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Workstations::V1beta::Workstations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Workstations::V1beta::PushCredentialsRequest.new
+              #
+              #   # Call the push_credentials method.
+              #   result = client.push_credentials 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 push_credentials request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Workstations::V1beta::PushCredentialsRequest
+
+                # 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.push_credentials.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::Workstations::V1beta::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.push_credentials.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.push_credentials.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @workstations_stub.push_credentials 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)
+              end
+
               ##
               # Configuration class for the Workstations REST API.
               #
@@ -2180,6 +2297,7 @@ module Google
               #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
               #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
               #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
               #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
               #       trigger a retry.
               #   @return [::Hash]
@@ -2259,6 +2377,7 @@ module Google
                 #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
                 #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
                 #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
                 #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
                 #         trigger a retry.
                 #
@@ -2363,6 +2482,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :generate_access_token
+                  ##
+                  # RPC-specific configuration for `push_credentials`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :push_credentials
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -2406,6 +2530,8 @@ module Google
                     @stop_workstation = ::Gapic::Config::Method.new stop_workstation_config
                     generate_access_token_config = parent_rpcs.generate_access_token if parent_rpcs.respond_to? :generate_access_token
                     @generate_access_token = ::Gapic::Config::Method.new generate_access_token_config
+                    push_credentials_config = parent_rpcs.push_credentials if parent_rpcs.respond_to? :push_credentials
+                    @push_credentials = ::Gapic::Config::Method.new push_credentials_config
 
                     yield self if block_given?
                   end

data/lib/google/cloud/workstations/v1beta/workstations/rest/operations.rb

@@ -541,6 +541,7 @@ module Google
               #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
               #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
               #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
               #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
               #       trigger a retry.
               #   @return [::Hash]
@@ -613,6 +614,7 @@ module Google
                 #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
                 #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
                 #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
                 #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
                 #         trigger a retry.
                 #

data/lib/google/cloud/workstations/v1beta/workstations/rest/service_stub.rb

@@ -873,6 +873,46 @@ module Google
                 end
               end
 
+              ##
+              # Baseline implementation for the push_credentials REST call
+              #
+              # @param request_pb [::Google::Cloud::Workstations::V1beta::PushCredentialsRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def push_credentials request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_push_credentials_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "push_credentials",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
               ##
               # @private
               #
@@ -1301,6 +1341,28 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the push_credentials REST call
+              #
+              # @param request_pb [::Google::Cloud::Workstations::V1beta::PushCredentialsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_push_credentials_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1beta/{workstation}:pushCredentials",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["workstation", %r{^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end