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

Defined in:
lib/google/cloud/monitoring/v3/group_service/client.rb

#create_group(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::Group #create_group(name: nil, group: nil, validate_only: nil) ⇒ ::Google::Cloud::Monitoring::V3::Group

Creates a new 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::CreateGroupRequest.new

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

# The returned object is of type Google::Cloud::Monitoring::V3::Group.
p result

Overloads:

  • #create_group(request, options = nil) ⇒ ::Google::Cloud::Monitoring::V3::Group

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

    Parameters:

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

  • #create_group(name: nil, group: nil, validate_only: nil) ⇒ ::Google::Cloud::Monitoring::V3::Group

    Pass arguments to create_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 project in which to create the group. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
    • group (::Google::Cloud::Monitoring::V3::Group, ::Hash) (defaults to: nil) —

      Required. A group definition. It is an error to define the name field because the system assigns the name.

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

      If true, validate this request but do not create the group.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.

[View source]

449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 449

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

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

  # 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_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.create_group.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_group.retry_policy

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

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