# frozen_string_literal: true # Copyright 2021 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/assuredworkloads/v1/assuredworkloads_pb" module Google module Cloud module AssuredWorkloads module V1 module AssuredWorkloadsService ## # Client for the AssuredWorkloadsService service. # # Service to manage AssuredWorkloads. # class Client # @private API_VERSION = "" # @private DEFAULT_ENDPOINT_TEMPLATE = "assuredworkloads.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :assured_workloads_service_stub ## # Configure the AssuredWorkloadsService Client class. # # See {::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all AssuredWorkloadsService clients # ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "AssuredWorkloads", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config end yield @configure if block_given? @configure end ## # Configure the AssuredWorkloadsService Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # The effective universe domain # # @return [String] # def universe_domain @assured_workloads_service_stub.universe_domain end ## # Create a new AssuredWorkloadsService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the AssuredWorkloadsService client. # @yieldparam config [Client::Configuration] # def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/assuredworkloads/v1/assuredworkloads_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @assured_workloads_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Operations] # attr_reader :operations_client # Service calls ## # Creates Assured Workload. # # @overload create_workload(request, options = nil) # Pass arguments to `create_workload` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::CreateWorkloadRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::CreateWorkloadRequest, ::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 create_workload(parent: nil, workload: nil, external_id: nil) # Pass arguments to `create_workload` 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 parent [::String] # Required. The resource name of the new Workload's parent. # Must be of the form `organizations/{org_id}/locations/{location_id}`. # @param workload [::Google::Cloud::AssuredWorkloads::V1::Workload, ::Hash] # Required. Assured Workload to create # @param external_id [::String] # Optional. A identifier associated with the workload and underlying projects which # allows for the break down of billing costs for a workload. The value # provided for the identifier will add a label to the workload and contained # projects with the identifier as the value. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::CreateWorkloadRequest.new # # # Call the create_workload method. # result = client.create_workload 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 create_workload request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::CreateWorkloadRequest # 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 metadata = @config.rpcs.create_workload.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_workload.timeout, metadata: metadata, retry_policy: @config.rpcs.create_workload.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :create_workload, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates an existing workload. # Currently allows updating of workload display_name and labels. # For force updates don't set etag field in the Workload. # Only one update operation per workload can be in progress. # # @overload update_workload(request, options = nil) # Pass arguments to `update_workload` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::UpdateWorkloadRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::UpdateWorkloadRequest, ::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 update_workload(workload: nil, update_mask: nil) # Pass arguments to `update_workload` 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 workload [::Google::Cloud::AssuredWorkloads::V1::Workload, ::Hash] # Required. The workload to update. # The workload's `name` field is used to identify the workload to be updated. # Format: # organizations/\\{org_id}/locations/\\{location_id}/workloads/\\{workload_id} # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Required. The list of fields to be updated. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::AssuredWorkloads::V1::Workload] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::AssuredWorkloads::V1::Workload] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::UpdateWorkloadRequest.new # # # Call the update_workload method. # result = client.update_workload request # # # The returned object is of type Google::Cloud::AssuredWorkloads::V1::Workload. # p result # def update_workload request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::UpdateWorkloadRequest # 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 metadata = @config.rpcs.update_workload.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.workload&.name header_params["workload.name"] = request.workload.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_workload.timeout, metadata: metadata, retry_policy: @config.rpcs.update_workload.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :update_workload, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Restrict the list of resources allowed in the Workload environment. # The current list of allowed products can be found at # https://cloud.google.com/assured-workloads/docs/supported-products # In addition to assuredworkloads.workload.update permission, the user should # also have orgpolicy.policy.set permission on the folder resource # to use this functionality. # # @overload restrict_allowed_resources(request, options = nil) # Pass arguments to `restrict_allowed_resources` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::RestrictAllowedResourcesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::RestrictAllowedResourcesRequest, ::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 restrict_allowed_resources(name: nil, restriction_type: nil) # Pass arguments to `restrict_allowed_resources` 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 name [::String] # Required. The resource name of the Workload. This is the workloads's # relative path in the API, formatted as # "organizations/\\{organization_id}/locations/\\{location_id}/workloads/\\{workload_id}". # For example, # "organizations/123/locations/us-east1/workloads/assured-workload-1". # @param restriction_type [::Google::Cloud::AssuredWorkloads::V1::RestrictAllowedResourcesRequest::RestrictionType] # Required. The type of restriction for using gcp products in the Workload environment. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::AssuredWorkloads::V1::RestrictAllowedResourcesResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::AssuredWorkloads::V1::RestrictAllowedResourcesResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::RestrictAllowedResourcesRequest.new # # # Call the restrict_allowed_resources method. # result = client.restrict_allowed_resources request # # # The returned object is of type Google::Cloud::AssuredWorkloads::V1::RestrictAllowedResourcesResponse. # p result # def restrict_allowed_resources request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::RestrictAllowedResourcesRequest # 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 metadata = @config.rpcs.restrict_allowed_resources.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.restrict_allowed_resources.timeout, metadata: metadata, retry_policy: @config.rpcs.restrict_allowed_resources.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :restrict_allowed_resources, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes the workload. Make sure that workload's direct children are already # in a deleted state, otherwise the request will fail with a # FAILED_PRECONDITION error. # # @overload delete_workload(request, options = nil) # Pass arguments to `delete_workload` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::DeleteWorkloadRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::DeleteWorkloadRequest, ::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 delete_workload(name: nil, etag: nil) # Pass arguments to `delete_workload` 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 name [::String] # Required. The `name` field is used to identify the workload. # Format: # organizations/\\{org_id}/locations/\\{location_id}/workloads/\\{workload_id} # @param etag [::String] # Optional. The etag of the workload. # If this is provided, it must match the server's etag. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::DeleteWorkloadRequest.new # # # Call the delete_workload method. # result = client.delete_workload request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_workload request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::DeleteWorkloadRequest # 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 metadata = @config.rpcs.delete_workload.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_workload.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_workload.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :delete_workload, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets Assured Workload associated with a CRM Node # # @overload get_workload(request, options = nil) # Pass arguments to `get_workload` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::GetWorkloadRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::GetWorkloadRequest, ::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 get_workload(name: nil) # Pass arguments to `get_workload` 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 name [::String] # Required. The resource name of the Workload to fetch. This is the workload's # relative path in the API, formatted as # "organizations/\\{organization_id}/locations/\\{location_id}/workloads/\\{workload_id}". # For example, # "organizations/123/locations/us-east1/workloads/assured-workload-1". # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::AssuredWorkloads::V1::Workload] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::AssuredWorkloads::V1::Workload] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::GetWorkloadRequest.new # # # Call the get_workload method. # result = client.get_workload request # # # The returned object is of type Google::Cloud::AssuredWorkloads::V1::Workload. # p result # def get_workload request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::GetWorkloadRequest # 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 metadata = @config.rpcs.get_workload.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_workload.timeout, metadata: metadata, retry_policy: @config.rpcs.get_workload.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :get_workload, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists Assured Workloads under a CRM Node. # # @overload list_workloads(request, options = nil) # Pass arguments to `list_workloads` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::ListWorkloadsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::ListWorkloadsRequest, ::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 list_workloads(parent: nil, page_size: nil, page_token: nil, filter: nil) # Pass arguments to `list_workloads` 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 parent [::String] # Required. Parent Resource to list workloads from. # Must be of the form `organizations/{org_id}/locations/{location}`. # @param page_size [::Integer] # Page size. # @param page_token [::String] # Page token returned from previous request. Page token contains context from # previous request. Page token needs to be passed in the second and following # requests. # @param filter [::String] # A custom filter for filtering by properties of a workload. At this time, # only filtering by labels is supported. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AssuredWorkloads::V1::Workload>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::AssuredWorkloads::V1::Workload>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::ListWorkloadsRequest.new # # # Call the list_workloads method. # result = client.list_workloads request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::AssuredWorkloads::V1::Workload. # p item # end # def list_workloads request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::ListWorkloadsRequest # 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 metadata = @config.rpcs.list_workloads.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_workloads.timeout, metadata: metadata, retry_policy: @config.rpcs.list_workloads.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :list_workloads, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @assured_workloads_service_stub, :list_workloads, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists the Violations in the AssuredWorkload Environment. # Callers may also choose to read across multiple Workloads as per # [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash # character) as a wildcard character instead of workload-id in the parent. # Format `organizations/{org_id}/locations/{location}/workloads/-` # # @overload list_violations(request, options = nil) # Pass arguments to `list_violations` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::ListViolationsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::ListViolationsRequest, ::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 list_violations(parent: nil, interval: nil, page_size: nil, page_token: nil, filter: nil) # Pass arguments to `list_violations` 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 parent [::String] # Required. The Workload name. # Format `organizations/{org_id}/locations/{location}/workloads/{workload}`. # @param interval [::Google::Cloud::AssuredWorkloads::V1::TimeWindow, ::Hash] # Optional. Specifies the time window for retrieving active Violations. # When specified, retrieves Violations that were active between start_time # and end_time. # @param page_size [::Integer] # Optional. Page size. # @param page_token [::String] # Optional. Page token returned from previous request. # @param filter [::String] # Optional. A custom filter for filtering by the Violations properties. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AssuredWorkloads::V1::Violation>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::AssuredWorkloads::V1::Violation>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::ListViolationsRequest.new # # # Call the list_violations method. # result = client.list_violations request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::AssuredWorkloads::V1::Violation. # p item # end # def list_violations request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::ListViolationsRequest # 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 metadata = @config.rpcs.list_violations.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_violations.timeout, metadata: metadata, retry_policy: @config.rpcs.list_violations.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :list_violations, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @assured_workloads_service_stub, :list_violations, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Retrieves Assured Workload Violation based on ID. # # @overload get_violation(request, options = nil) # Pass arguments to `get_violation` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::GetViolationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::GetViolationRequest, ::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 get_violation(name: nil) # Pass arguments to `get_violation` 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 name [::String] # Required. The resource name of the Violation to fetch (ie. Violation.name). # Format: # organizations/\\{organization}/locations/\\{location}/workloads/\\{workload}/violations/\\{violation} # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::AssuredWorkloads::V1::Violation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::AssuredWorkloads::V1::Violation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::GetViolationRequest.new # # # Call the get_violation method. # result = client.get_violation request # # # The returned object is of type Google::Cloud::AssuredWorkloads::V1::Violation. # p result # def get_violation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::GetViolationRequest # 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 metadata = @config.rpcs.get_violation.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_violation.timeout, metadata: metadata, retry_policy: @config.rpcs.get_violation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :get_violation, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Acknowledges an existing violation. By acknowledging a violation, users # acknowledge the existence of a compliance violation in their workload and # decide to ignore it due to a valid business justification. Acknowledgement # is a permanent operation and it cannot be reverted. # # @overload acknowledge_violation(request, options = nil) # Pass arguments to `acknowledge_violation` via a request object, either of type # {::Google::Cloud::AssuredWorkloads::V1::AcknowledgeViolationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AssuredWorkloads::V1::AcknowledgeViolationRequest, ::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 acknowledge_violation(name: nil, comment: nil, non_compliant_org_policy: nil) # Pass arguments to `acknowledge_violation` 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 name [::String] # Required. The resource name of the Violation to acknowledge. # Format: # organizations/\\{organization}/locations/\\{location}/workloads/\\{workload}/violations/\\{violation} # @param comment [::String] # Required. Business justification explaining the need for violation acknowledgement # @param non_compliant_org_policy [::String] # Optional. This field is deprecated and will be removed in future version of the API. # Name of the OrgPolicy which was modified with non-compliant change and # resulted in this violation. # Format: # projects/\\{project_number}/policies/\\{constraint_name} # folders/\\{folder_id}/policies/\\{constraint_name} # organizations/\\{organization_id}/policies/\\{constraint_name} # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::AssuredWorkloads::V1::AcknowledgeViolationResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::AssuredWorkloads::V1::AcknowledgeViolationResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/assured_workloads/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::AssuredWorkloads::V1::AcknowledgeViolationRequest.new # # # Call the acknowledge_violation method. # result = client.acknowledge_violation request # # # The returned object is of type Google::Cloud::AssuredWorkloads::V1::AcknowledgeViolationResponse. # p result # def acknowledge_violation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AssuredWorkloads::V1::AcknowledgeViolationRequest # 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 metadata = @config.rpcs.acknowledge_violation.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers 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::AssuredWorkloads::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.acknowledge_violation.timeout, metadata: metadata, retry_policy: @config.rpcs.acknowledge_violation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @assured_workloads_service_stub.call_rpc :acknowledge_violation, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the AssuredWorkloadsService API. # # This class represents the configuration for AssuredWorkloadsService, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # create_workload to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_workload.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::AssuredWorkloads::V1::AssuredWorkloadsService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_workload.timeout = 20.0 # end # # @!attribute [rw] endpoint # A custom service endpoint, as a hostname or hostname:port. The default is # nil, indicating to use the default endpoint in the current universe domain. # @return [::String,nil] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `: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. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # @!attribute [rw] universe_domain # The universe domain within which to make requests. This determines the # default endpoint URL. The default value of nil uses the environment # universe (usually the default "googleapis.com" universe). # @return [::String,nil] # class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "assuredworkloads.googleapis.com" config_attr :endpoint, nil, ::String, nil config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration for the channel pool # @return [::Gapic::ServiceStub::ChannelPool::Configuration] # def channel_pool @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new end ## # Configuration RPC class for the AssuredWorkloadsService API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `: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. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_workload` # @return [::Gapic::Config::Method] # attr_reader :create_workload ## # RPC-specific configuration for `update_workload` # @return [::Gapic::Config::Method] # attr_reader :update_workload ## # RPC-specific configuration for `restrict_allowed_resources` # @return [::Gapic::Config::Method] # attr_reader :restrict_allowed_resources ## # RPC-specific configuration for `delete_workload` # @return [::Gapic::Config::Method] # attr_reader :delete_workload ## # RPC-specific configuration for `get_workload` # @return [::Gapic::Config::Method] # attr_reader :get_workload ## # RPC-specific configuration for `list_workloads` # @return [::Gapic::Config::Method] # attr_reader :list_workloads ## # RPC-specific configuration for `list_violations` # @return [::Gapic::Config::Method] # attr_reader :list_violations ## # RPC-specific configuration for `get_violation` # @return [::Gapic::Config::Method] # attr_reader :get_violation ## # RPC-specific configuration for `acknowledge_violation` # @return [::Gapic::Config::Method] # attr_reader :acknowledge_violation # @private def initialize parent_rpcs = nil create_workload_config = parent_rpcs.create_workload if parent_rpcs.respond_to? :create_workload @create_workload = ::Gapic::Config::Method.new create_workload_config update_workload_config = parent_rpcs.update_workload if parent_rpcs.respond_to? :update_workload @update_workload = ::Gapic::Config::Method.new update_workload_config restrict_allowed_resources_config = parent_rpcs.restrict_allowed_resources if parent_rpcs.respond_to? :restrict_allowed_resources @restrict_allowed_resources = ::Gapic::Config::Method.new restrict_allowed_resources_config delete_workload_config = parent_rpcs.delete_workload if parent_rpcs.respond_to? :delete_workload @delete_workload = ::Gapic::Config::Method.new delete_workload_config get_workload_config = parent_rpcs.get_workload if parent_rpcs.respond_to? :get_workload @get_workload = ::Gapic::Config::Method.new get_workload_config list_workloads_config = parent_rpcs.list_workloads if parent_rpcs.respond_to? :list_workloads @list_workloads = ::Gapic::Config::Method.new list_workloads_config list_violations_config = parent_rpcs.list_violations if parent_rpcs.respond_to? :list_violations @list_violations = ::Gapic::Config::Method.new list_violations_config get_violation_config = parent_rpcs.get_violation if parent_rpcs.respond_to? :get_violation @get_violation = ::Gapic::Config::Method.new get_violation_config acknowledge_violation_config = parent_rpcs.acknowledge_violation if parent_rpcs.respond_to? :acknowledge_violation @acknowledge_violation = ::Gapic::Config::Method.new acknowledge_violation_config yield self if block_given? end end end end end end end end end