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

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

#list_group_members(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResource> #list_group_members(name: nil, page_size: nil, page_token: nil, filter: nil, interval: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResource>

Lists the monitored resources that are members of a 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::ListGroupMembersRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Api::MonitoredResource.
  p response
end

Overloads:

  • #list_group_members(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResource>

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

    Parameters:

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

  • #list_group_members(name: nil, page_size: nil, page_token: nil, filter: nil, interval: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResource>

    Pass arguments to list_group_members 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 whose members are listed. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
    • page_size (::Integer) (defaults to: nil) —

      A positive number that is the maximum number of results to return.

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

      If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

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

      An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:

      `resource.type = "gce_instance"`
    • interval (::Google::Cloud::Monitoring::V3::TimeInterval, ::Hash) (defaults to: nil) —

      An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.


742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/google/cloud/monitoring/v3/group_service/client.rb', line 742

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

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

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

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

  @group_service_stub.call_rpc :list_group_members, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @group_service_stub, :list_group_members, 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