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

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

REST client for the FeaturedContentNativeDashboardService service.

This service provides functionality for managing FeaturedContentNativeDashboard.

Inherits

  • Object

Includes

Methods

.configure

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

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

#configure

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

Configure the FeaturedContentNativeDashboardService 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_featured_content_native_dashboard

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

Get a native dashboard featured content.

Overloads 
def get_featured_content_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard
Pass arguments to get_featured_content_native_dashboard via a request object, either of type GetFeaturedContentNativeDashboardRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetFeaturedContentNativeDashboardRequest, ::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_featured_content_native_dashboard(name: nil) -> ::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard
Pass arguments to get_featured_content_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 resource name of the FeaturedContentNativeDashboard to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_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::FeaturedContentNativeDashboardService::Rest::Client.new

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

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

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

#initialize

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

Create a new FeaturedContentNativeDashboardService REST client object.

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

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

#install_featured_content_native_dashboard

def install_featured_content_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::InstallFeaturedContentNativeDashboardResponse
def install_featured_content_native_dashboard(name: nil, featured_content_native_dashboard: nil) -> ::Google::Cloud::Chronicle::V1::InstallFeaturedContentNativeDashboardResponse

Install a native dashboard featured content.

Overloads 
def install_featured_content_native_dashboard(request, options = nil) -> ::Google::Cloud::Chronicle::V1::InstallFeaturedContentNativeDashboardResponse
Pass arguments to install_featured_content_native_dashboard via a request object, either of type InstallFeaturedContentNativeDashboardRequest or an equivalent Hash.
Parameters 
def install_featured_content_native_dashboard(name: nil, featured_content_native_dashboard: nil) -> ::Google::Cloud::Chronicle::V1::InstallFeaturedContentNativeDashboardResponse
Pass arguments to install_featured_content_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 resource name of the FeaturedContentNativeDashboard to install. Format: projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentNativeDashboards/{featured_content_native_dashboard}
  • featured_content_native_dashboard (::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard, ::Hash) — Optional. The FeaturedContentNativeDashboard to install.
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::FeaturedContentNativeDashboardService::Rest::Client.new

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

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

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

#list_featured_content_native_dashboards

def list_featured_content_native_dashboards(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard>
def list_featured_content_native_dashboards(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard>

List all native dashboards featured content.

Overloads 
def list_featured_content_native_dashboards(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard>
Pass arguments to list_featured_content_native_dashboards via a request object, either of type ListFeaturedContentNativeDashboardsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ListFeaturedContentNativeDashboardsRequest, ::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_featured_content_native_dashboards(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard>
Pass arguments to list_featured_content_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, which owns this collection of FeaturedContentNativeDashboards. Format: projects/{project}/locations/{location}/instances/{instance}/contentHub
  • page_size (::Integer) — Optional. The maximum number of FeaturedContentNativeDashboards to return. The service may return fewer than this value. If unspecified, at most 100 FeaturedContentNativeDashboards will be returned. The maximum value is 100; values above 100 will be coerced to 100.
  • page_token (::String) — Optional. A page token, received from a previous ListFeaturedContentNativeDashboards call. Provide this to retrieve the subsequent page.

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

  • filter (::String) —

    Optional. The filter to apply to list the FeaturedContentNativeDashboards.

    The filter syntax follows Google Cloud syntax: https://google.aip.dev/160.

    Supported fields for filtering:

    • name: The resource name of the featured content.
    • content_metadata.description: The description of the featured content.

    When a literal value is provided without a field, it will perform a substring search across both name and content_metadata.description.

    Examples:

    • "test": Matches featured content where either the name or description contains "test" as a substring.
    • name="test": Matches featured content where the name contains "test".
    • content_metadata.description="test": Matches featured content where the description contains "test".
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::FeaturedContentNativeDashboardService::Rest::Client.new

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

# Call the list_featured_content_native_dashboards method.
result = client.list_featured_content_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::FeaturedContentNativeDashboard.
  p item
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)