Chronicle V1 API - Class Google::Cloud::Chronicle::V1::DashboardChartService::Client (v0.6.0)

Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::DashboardChartService::Client.

Client for the DashboardChartService service.

A service providing functionality for managing dashboards' charts.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the DashboardChartService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all DashboardChartService clients
::Google::Cloud::Chronicle::V1::DashboardChartService::Client.configure do |config|
  config.timeout = 10.0
end

#batch_get_dashboard_charts

def batch_get_dashboard_charts(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BatchGetDashboardChartsResponse
def batch_get_dashboard_charts(parent: nil, names: nil) -> ::Google::Cloud::Chronicle::V1::BatchGetDashboardChartsResponse

Get dashboard charts in batches.

Overloads 
def batch_get_dashboard_charts(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BatchGetDashboardChartsResponse
Pass arguments to batch_get_dashboard_charts via a request object, either of type BatchGetDashboardChartsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::BatchGetDashboardChartsRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def batch_get_dashboard_charts(parent: nil, names: nil) -> ::Google::Cloud::Chronicle::V1::BatchGetDashboardChartsResponse
Pass arguments to batch_get_dashboard_charts 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) — Required. The parent resource shared by all dashboard charts being retrieved. Format: projects/{project}/locations/{location}/instances/{instance} If this is set, the parent of all of the dashboard charts specified in names must match this field.
  • names (::Array<::String>) — Required. The names of the dashboard charts to get.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/chronicle/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Chronicle::V1::DashboardChartService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Chronicle::V1::BatchGetDashboardChartsRequest.new

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

# The returned object is of type Google::Cloud::Chronicle::V1::BatchGetDashboardChartsResponse.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the DashboardChartService 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 Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#get_dashboard_chart

def get_dashboard_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DashboardChart
def get_dashboard_chart(name: nil) -> ::Google::Cloud::Chronicle::V1::DashboardChart

Get a dashboard chart.

Overloads 
def get_dashboard_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DashboardChart
Pass arguments to get_dashboard_chart via a request object, either of type GetDashboardChartRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetDashboardChartRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_dashboard_chart(name: nil) -> ::Google::Cloud::Chronicle::V1::DashboardChart
Pass arguments to get_dashboard_chart 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).
Parameter
  • name (::String) — Required. The name of the dashboardChart to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardCharts/{chart}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/chronicle/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Chronicle::V1::DashboardChartService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Chronicle::V1::GetDashboardChartRequest.new

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

# The returned object is of type Google::Cloud::Chronicle::V1::DashboardChart.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new DashboardChartService client object.

Yields
  • (config) — Configure the DashboardChartService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Chronicle::V1::DashboardChartService::Client.new

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)