class Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client

Client for the DashboardsService service.

Manages Stackdriver dashboards. A dashboard is an arrangement of data display widgets in a specific layout.

Attributes

dashboards_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the DashboardsService Client class.

See {::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all DashboardsService clients
::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb, line 58
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Monitoring", "Dashboard", "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 = 30.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_dashboard.timeout = 30.0

    default_config.rpcs.delete_dashboard.timeout = 30.0

    default_config.rpcs.update_dashboard.timeout = 30.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new DashboardsService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the DashboardsService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb, line 122
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/monitoring/dashboard/v1/dashboards_service_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 == Client.configure.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

  @dashboards_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the DashboardsService 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::Monitoring::Dashboard::V1::DashboardsService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb, line 101
def configure
  yield @config if block_given?
  @config
end
create_dashboard(request, options = nil) { |response, operation| ... } click to toggle source

Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](cloud.google.com/iam).

@overload create_dashboard(request, options = nil)

Pass arguments to `create_dashboard` via a request object, either of type
{::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest} or an equivalent Hash.

@param request [::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest, ::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_dashboard(parent: nil, dashboard: nil, validate_only: nil)

Pass arguments to `create_dashboard` 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 project on which to execute the request. The format is:

      projects/[PROJECT_ID_OR_NUMBER]

  The `[PROJECT_ID_OR_NUMBER]` must match the dashboard resource name.
@param dashboard [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash]
  Required. The initial dashboard specification.
@param validate_only [::Boolean]
  If set, validate the request and preview the review, but do not actually
  save it.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb, line 199
def create_dashboard request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest

  # 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_dashboard.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::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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_dashboard.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_dashboard.retry_policy

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

  @dashboards_service_stub.call_rpc :create_dashboard, 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
delete_dashboard(request, options = nil) { |response, operation| ... } click to toggle source

Deletes an existing custom dashboard.

This method requires the `monitoring.dashboards.delete` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](cloud.google.com/iam).

@overload delete_dashboard(request, options = nil)

Pass arguments to `delete_dashboard` via a request object, either of type
{::Google::Cloud::Monitoring::Dashboard::V1::DeleteDashboardRequest} or an equivalent Hash.

@param request [::Google::Cloud::Monitoring::Dashboard::V1::DeleteDashboardRequest, ::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_dashboard(name: nil)

Pass arguments to `delete_dashboard` 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 Dashboard. The format is:

      projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]

@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.

# File lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb, line 431
def delete_dashboard request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::DeleteDashboardRequest

  # 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_dashboard.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::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_dashboard.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_dashboard.retry_policy

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

  @dashboards_service_stub.call_rpc :delete_dashboard, 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
get_dashboard(request, options = nil) { |response, operation| ... } click to toggle source

Fetches a specific dashboard.

This method requires the `monitoring.dashboards.get` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](cloud.google.com/iam).

@overload get_dashboard(request, options = nil)

Pass arguments to `get_dashboard` via a request object, either of type
{::Google::Cloud::Monitoring::Dashboard::V1::GetDashboardRequest} or an equivalent Hash.

@param request [::Google::Cloud::Monitoring::Dashboard::V1::GetDashboardRequest, ::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_dashboard(name: nil)

Pass arguments to `get_dashboard` 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 Dashboard. The format is one of:

   -  `dashboards/[DASHBOARD_ID]` (for system dashboards)
   -  `projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]`
        (for custom dashboards).

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb, line 357
def get_dashboard request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::GetDashboardRequest

  # 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_dashboard.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::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_dashboard.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_dashboard.retry_policy

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

  @dashboards_service_stub.call_rpc :get_dashboard, 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
list_dashboards(request, options = nil) { |response, operation| ... } click to toggle source

Lists the existing dashboards.

This method requires the `monitoring.dashboards.list` permission on the specified project. For more information, see [Cloud Identity and Access Management](cloud.google.com/iam).

@overload list_dashboards(request, options = nil)

Pass arguments to `list_dashboards` via a request object, either of type
{::Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsRequest, ::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_dashboards(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_dashboards` 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 scope of the dashboards to list. The format is:

      projects/[PROJECT_ID_OR_NUMBER]
@param page_size [::Integer]
  A positive number that is the maximum number of results to return.
  If unspecified, a default of 1000 is used.
@param page_token [::String]
  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 additional results from the previous method call.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::Dashboard::V1::Dashboard>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Monitoring::Dashboard::V1::Dashboard>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb, line 280
def list_dashboards request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsRequest

  # 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_dashboards.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::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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_dashboards.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_dashboards.retry_policy

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

  @dashboards_service_stub.call_rpc :list_dashboards, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dashboards_service_stub, :list_dashboards, 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
update_dashboard(request, options = nil) { |response, operation| ... } click to toggle source

Replaces an existing custom dashboard with a new definition.

This method requires the `monitoring.dashboards.update` permission on the specified dashboard. For more information, see [Cloud Identity and Access Management](cloud.google.com/iam).

@overload update_dashboard(request, options = nil)

Pass arguments to `update_dashboard` via a request object, either of type
{::Google::Cloud::Monitoring::Dashboard::V1::UpdateDashboardRequest} or an equivalent Hash.

@param request [::Google::Cloud::Monitoring::Dashboard::V1::UpdateDashboardRequest, ::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_dashboard(dashboard: nil, validate_only: nil)

Pass arguments to `update_dashboard` 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 dashboard [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash]
  Required. The dashboard that will replace the existing dashboard.
@param validate_only [::Boolean]
  If set, validate the request and preview the review, but do not actually
  save it.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb, line 506
def update_dashboard request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::Dashboard::V1::UpdateDashboardRequest

  # 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_dashboard.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::Dashboard::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "dashboard.name" => request.dashboard.name
  }
  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_dashboard.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_dashboard.retry_policy

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

  @dashboards_service_stub.call_rpc :update_dashboard, 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