0.9.0 (latest) 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.0 Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::DashboardChartService::Rest::Client.

REST client for the DashboardChartService service.


<br />

A service providing functionality for managing dashboards' charts.

## Inherits

- Object

## Includes

- [Google::Cloud::Chronicle::V1::DashboardChartService::Paths](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Paths)

## Methods

### .configure

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

Configure the DashboardChartService Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client-Configuration "Google::Cloud::Chronicle::V1::DashboardChartService::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client-Configuration))
**Example**

```ruby
# Modify the configuration for all DashboardChartService clients
::Google::Cloud::Chronicle::V1::DashboardChartService::Rest::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-BatchGetDashboardChartsRequest "Google::Cloud::Chronicle::V1::BatchGetDashboardChartsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Chronicle::V1::BatchGetDashboardChartsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/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**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Chronicle::V1::BatchGetDashboardChartsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-BatchGetDashboardChartsResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Chronicle::V1::BatchGetDashboardChartsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-BatchGetDashboardChartsResponse))
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/chronicle/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Chronicle::V1::DashboardChartService::Rest::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client#Google__Cloud__Chronicle__V1__DashboardChartService__Rest__Client_configure_class_ "Google::Cloud::Chronicle::V1::DashboardChartService::Rest::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client-Configuration "Google::Cloud::Chronicle::V1::DashboardChartService::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client-Configuration))

### #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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-GetDashboardChartRequest "Google::Cloud::Chronicle::V1::GetDashboardChartRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Chronicle::V1::GetDashboardChartRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/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**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Chronicle::V1::DashboardChart](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChart))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Chronicle::V1::DashboardChart](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChart))
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/chronicle/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Chronicle::V1::DashboardChartService::Rest::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 REST client object.
**Yields**

- (config) --- Configure the DashboardChartService client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-Rest-Client)) --- a new instance of Client
**Example**

```ruby
# Create a client using the default configuration
client = ::Google::Cloud::Chronicle::V1::DashboardChartService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Chronicle::V1::DashboardChartService::Rest::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)