Method: Google::Cloud::Monitoring::V3::UptimeCheckService::Client#list_uptime_check_configs

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

#list_uptime_check_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::UptimeCheckConfig> #list_uptime_check_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::UptimeCheckConfig>

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

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::UptimeCheckService::Client.new

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

# Call the list_uptime_check_configs method.
result = client.list_uptime_check_configs 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::Cloud::Monitoring::V3::UptimeCheckConfig.
  p response
end

Overloads:

  • #list_uptime_check_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::UptimeCheckConfig>

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

    Parameters:

    • request (::Google::Cloud::Monitoring::V3::ListUptimeCheckConfigsRequest, ::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_uptime_check_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::V3::UptimeCheckConfig>

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

    Parameters:

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

      Required. The project whose Uptime check configurations are listed. The format is:

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

      The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.

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

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

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]

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/google/cloud/monitoring/v3/uptime_check_service/client.rb', line 242

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

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

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

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

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