Method: Google::Cloud::Monitoring::V3::GroupService::Client#delete_group

Defined in:

lib/google/cloud/monitoring/v3/group_service/client.rb

#delete_group(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_group(name: nil, recursive: nil) ⇒ ::Google::Protobuf::Empty

Deletes an existing group.

Examples:

Basic example

require "google/cloud/monitoring/v3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Monitoring::V3::GroupService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Monitoring::V3::DeleteGroupRequest.new

# Call the delete_group method.
result = client.delete_group request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

• #delete_group(request, options = nil) ⇒ ::Google::Protobuf::Empty

  Pass arguments to delete_group via a request object, either of type DeleteGroupRequest or an equivalent Hash.

  Parameters:

  • request (::Google::Cloud::Monitoring::V3::DeleteGroupRequest, ::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.

  • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

• #delete_group(name: nil, recursive: nil) ⇒ ::Google::Protobuf::Empty

  Pass arguments to delete_group 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).

  Parameters:

  • name (::String) (defaults to: nil) —

    Required. The group to delete. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
    

  • recursive (::Boolean) (defaults to: nil) —

    If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false.

Yields:

• (response, operation) —

  Access the result along with the RPC operation

Yield Parameters:

• response (::Google::Protobuf::Empty)
• operation (::GRPC::ActiveCall::Operation)

Returns:

• (::Google::Protobuf::Empty)

Raises:

• (::Google::Cloud::Error) —

  if the RPC is aborted.

# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 629

def delete_group request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::DeleteGroupRequest

  # 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_group.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Monitoring::V3::VERSION
  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_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_group.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @group_service_stub.call_rpc :delete_group, 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