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

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

REST client for the NativeDashboardService service.

A service providing functionality for managing native dashboards.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the NativeDashboardService 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 NativeDashboardService clients
::Google::Cloud::Chronicle::V1::NativeDashboardService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#add_chart

def add_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::AddChartResponse
def add_chart(name: nil, dashboard_query: nil, dashboard_chart: nil, chart_layout: nil) -> ::Google::Cloud::Chronicle::V1::AddChartResponse

Add chart in a dashboard.

Overloads 
def add_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::AddChartResponse
Pass arguments to add_chart via a request object, either of type AddChartRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::AddChartRequest, ::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 add_chart(name: nil, dashboard_query: nil, dashboard_chart: nil, chart_layout: nil) -> ::Google::Cloud::Chronicle::V1::AddChartResponse
Pass arguments to add_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).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#configure

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

Configure the NativeDashboardService 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

#create_native_dashboard

def create_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
def create_native_dashboard(parent: nil, native_dashboard: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard

Create a dashboard.

Overloads 
def create_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to create_native_dashboard via a request object, either of type CreateNativeDashboardRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::CreateNativeDashboardRequest, ::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 create_native_dashboard(parent: nil, native_dashboard: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to create_native_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).
Parameters
  • parent (::String) — Required. The parent resource where this dashboard will be created. Format: projects/{project}/locations/{location}/instances/{instance}
  • native_dashboard (::Google::Cloud::Chronicle::V1::NativeDashboard, ::Hash) — Required. The dashboard to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#delete_native_dashboard

def delete_native_dashboard(request, options = nil) -> ::Google::Protobuf::Empty
def delete_native_dashboard(name: nil) -> ::Google::Protobuf::Empty

Delete a dashboard.

Overloads 
def delete_native_dashboard(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_native_dashboard via a request object, either of type DeleteNativeDashboardRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::DeleteNativeDashboardRequest, ::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 delete_native_dashboard(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_native_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).
Parameter
  • name (::String) — Required. The dashboard name to delete. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

#duplicate_chart

def duplicate_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DuplicateChartResponse
def duplicate_chart(name: nil, dashboard_chart: nil) -> ::Google::Cloud::Chronicle::V1::DuplicateChartResponse

Duplicate chart in a dashboard.

Overloads 
def duplicate_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DuplicateChartResponse
Pass arguments to duplicate_chart via a request object, either of type DuplicateChartRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::DuplicateChartRequest, ::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 duplicate_chart(name: nil, dashboard_chart: nil) -> ::Google::Cloud::Chronicle::V1::DuplicateChartResponse
Pass arguments to duplicate_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).
Parameters
  • name (::String) — Required. The dashboard name that involves chart duplication. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
  • dashboard_chart (::String) — Required. The dashboard chart name to duplicate.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#duplicate_native_dashboard

def duplicate_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
def duplicate_native_dashboard(name: nil, native_dashboard: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard

Duplicate a dashboard.

Overloads 
def duplicate_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to duplicate_native_dashboard via a request object, either of type DuplicateNativeDashboardRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::DuplicateNativeDashboardRequest, ::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 duplicate_native_dashboard(name: nil, native_dashboard: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to duplicate_native_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).
Parameters
  • name (::String) — Required. The dashboard name to duplicate. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
  • native_dashboard (::Google::Cloud::Chronicle::V1::NativeDashboard, ::Hash) — Required. Any fields that need modification can be passed through this like name, description etc.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#edit_chart

def edit_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::EditChartResponse
def edit_chart(name: nil, dashboard_query: nil, dashboard_chart: nil, edit_mask: nil, language_features: nil) -> ::Google::Cloud::Chronicle::V1::EditChartResponse

Edit chart in a dashboard.

Overloads 
def edit_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::EditChartResponse
Pass arguments to edit_chart via a request object, either of type EditChartRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::EditChartRequest, ::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 edit_chart(name: nil, dashboard_query: nil, dashboard_chart: nil, edit_mask: nil, language_features: nil) -> ::Google::Cloud::Chronicle::V1::EditChartResponse
Pass arguments to edit_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).
Parameters
  • name (::String) — Required. The dashboard name to edit chart in. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
  • dashboard_query (::Google::Cloud::Chronicle::V1::DashboardQuery, ::Hash) — Optional. Query for the edited chart.
  • dashboard_chart (::Google::Cloud::Chronicle::V1::DashboardChart, ::Hash) — Optional. Edited chart.
  • edit_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The list of fields to edit for chart and query. Supported paths in chart are - dashboard_chart.display_name dashboard_chart.description dashboard_chart.chart_datasource.data_sources dashboard_chart.visualization dashboard_chart.visualization.button dashboard_chart.visualization.markdown dashboard_chart.drill_down_config Supported paths in query are - dashboard_query.query dashboard_query.input
  • language_features (::Array<::Google::Cloud::Chronicle::V1::LanguageFeature>) — Optional. Language Features present in the query.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#export_native_dashboards

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

Exports the dashboards.

Overloads 
def export_native_dashboards(request, options = nil) -> ::Google::Cloud::Chronicle::V1::ExportNativeDashboardsResponse
Pass arguments to export_native_dashboards via a request object, either of type ExportNativeDashboardsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ExportNativeDashboardsRequest, ::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 export_native_dashboards(parent: nil, names: nil) -> ::Google::Cloud::Chronicle::V1::ExportNativeDashboardsResponse
Pass arguments to export_native_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).
Parameters
  • parent (::String) — Required. The parent resource that the dashboards to be exported belong to. Format: projects/{project}/locations/{location}/instances/{instance}
  • names (::Array<::String>) — Required. The resource names of the dashboards to export.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#get_native_dashboard

def get_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
def get_native_dashboard(name: nil, view: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard

Get a dashboard.

Overloads 
def get_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to get_native_dashboard via a request object, either of type GetNativeDashboardRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetNativeDashboardRequest, ::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_native_dashboard(name: nil, view: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to get_native_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).
Parameters
  • name (::String) — Required. The dashboard name to fetch. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
  • view (::Google::Cloud::Chronicle::V1::NativeDashboardView) — Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#import_native_dashboards

def import_native_dashboards(request, options = nil) -> ::Google::Cloud::Chronicle::V1::ImportNativeDashboardsResponse
def import_native_dashboards(parent: nil, source: nil) -> ::Google::Cloud::Chronicle::V1::ImportNativeDashboardsResponse

Imports the dashboards.

Overloads 
def import_native_dashboards(request, options = nil) -> ::Google::Cloud::Chronicle::V1::ImportNativeDashboardsResponse
Pass arguments to import_native_dashboards via a request object, either of type ImportNativeDashboardsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ImportNativeDashboardsRequest, ::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 import_native_dashboards(parent: nil, source: nil) -> ::Google::Cloud::Chronicle::V1::ImportNativeDashboardsResponse
Pass arguments to import_native_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).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#initialize

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

Create a new NativeDashboardService REST client object.

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

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

#list_native_dashboards

def list_native_dashboards(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::NativeDashboard>
def list_native_dashboards(parent: nil, page_size: nil, page_token: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::NativeDashboard>

List all dashboards.

Overloads 
def list_native_dashboards(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::NativeDashboard>
Pass arguments to list_native_dashboards via a request object, either of type ListNativeDashboardsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ListNativeDashboardsRequest, ::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 list_native_dashboards(parent: nil, page_size: nil, page_token: nil, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::NativeDashboard>
Pass arguments to list_native_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).
Parameters
  • parent (::String) — Required. The parent owning this dashboard collection. Format: projects/{project}/locations/{location}/instances/{instance}
  • page_size (::Integer) — Optional. The maximum number of dashboards to return. The service may return fewer than this value.
  • page_token (::String) — Optional. A page token, received from a previous ListDashboards call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

  • view (::Google::Cloud::Chronicle::V1::NativeDashboardView) — Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Chronicle::V1::NativeDashboard.
  p item
end

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#remove_chart

def remove_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
def remove_chart(name: nil, dashboard_chart: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard

Remove chart from a dashboard.

Overloads 
def remove_chart(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to remove_chart via a request object, either of type RemoveChartRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::RemoveChartRequest, ::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 remove_chart(name: nil, dashboard_chart: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to remove_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).
Parameters
  • name (::String) — Required. The dashboard name to remove chart from. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
  • dashboard_chart (::String) — Required. The dashboard chart name to remove.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_native_dashboard

def update_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
def update_native_dashboard(native_dashboard: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard

Update a dashboard.

Overloads 
def update_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to update_native_dashboard via a request object, either of type UpdateNativeDashboardRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::UpdateNativeDashboardRequest, ::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 update_native_dashboard(native_dashboard: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::NativeDashboard
Pass arguments to update_native_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).
Parameters
  • native_dashboard (::Google::Cloud::Chronicle::V1::NativeDashboard, ::Hash) — Required. The dashboard to update.

    The dashboard's name field is used to identify the dashboard to update. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. LINT.IfChange(update_mask_values) The list of fields to update. Supported paths are - display_name description definition.filters definition.charts type access dashboard_user_data.is_pinned
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call 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::NativeDashboardService::Rest::Client.new

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

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

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