Chronicle API - Module Google::Cloud::Chronicle (v0.4.0)

Reference documentation and code samples for the Chronicle API module Google::Cloud::Chronicle.

Methods

.big_query_export_service

def self.big_query_export_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for BigQueryExportService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::BigQueryExportService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the BigQueryExportService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the BigQueryExportService service. You can determine whether the method will succeed by calling Chronicle.big_query_export_service_available?.

About BigQueryExportService

Service for managing BigQuery export configurations for Chronicle instances.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.big_query_export_service_available?

def self.big_query_export_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the BigQueryExportService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.big_query_export_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the BigQueryExportService service, or if the versioned client gem needs an update to support the BigQueryExportService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-chronicle library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.chronicle)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.dashboard_chart_service

def self.dashboard_chart_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DashboardChartService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::DashboardChartService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DashboardChartService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DashboardChartService service. You can determine whether the method will succeed by calling Chronicle.dashboard_chart_service_available?.

About DashboardChartService

A service providing functionality for managing dashboards' charts.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.dashboard_chart_service_available?

def self.dashboard_chart_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DashboardChartService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.dashboard_chart_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DashboardChartService service, or if the versioned client gem needs an update to support the DashboardChartService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.dashboard_query_service

def self.dashboard_query_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DashboardQueryService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::DashboardQueryService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DashboardQueryService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DashboardQueryService service. You can determine whether the method will succeed by calling Chronicle.dashboard_query_service_available?.

About DashboardQueryService

A service providing functionality for managing dashboards' queries.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.dashboard_query_service_available?

def self.dashboard_query_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DashboardQueryService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.dashboard_query_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DashboardQueryService service, or if the versioned client gem needs an update to support the DashboardQueryService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.data_access_control_service

def self.data_access_control_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DataAccessControlService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::DataAccessControlService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DataAccessControlService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataAccessControlService service. You can determine whether the method will succeed by calling Chronicle.data_access_control_service_available?.

About DataAccessControlService

DataAccessControlService exposes resources and endpoints related to data access control.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.data_access_control_service_available?

def self.data_access_control_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DataAccessControlService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.data_access_control_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataAccessControlService service, or if the versioned client gem needs an update to support the DataAccessControlService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.data_table_service

def self.data_table_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DataTableService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::DataTableService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DataTableService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataTableService service. You can determine whether the method will succeed by calling Chronicle.data_table_service_available?.

About DataTableService

DataTableManager provides an interface for managing data tables.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.data_table_service_available?

def self.data_table_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DataTableService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.data_table_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataTableService service, or if the versioned client gem needs an update to support the DataTableService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.entity_service

def self.entity_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for EntityService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::EntityService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the EntityService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the EntityService service. You can determine whether the method will succeed by calling Chronicle.entity_service_available?.

About EntityService

EntityService contains apis for finding entities.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.entity_service_available?

def self.entity_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the EntityService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.entity_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the EntityService service, or if the versioned client gem needs an update to support the EntityService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.featured_content_native_dashboard_service

def self.featured_content_native_dashboard_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for FeaturedContentNativeDashboardService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboardService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the FeaturedContentNativeDashboardService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the FeaturedContentNativeDashboardService service. You can determine whether the method will succeed by calling Chronicle.featured_content_native_dashboard_service_available?.

About FeaturedContentNativeDashboardService

This service provides functionality for managing FeaturedContentNativeDashboard.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.featured_content_native_dashboard_service_available?

def self.featured_content_native_dashboard_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the FeaturedContentNativeDashboardService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.featured_content_native_dashboard_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the FeaturedContentNativeDashboardService service, or if the versioned client gem needs an update to support the FeaturedContentNativeDashboardService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.instance_service

def self.instance_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for InstanceService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::InstanceService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the InstanceService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the InstanceService service. You can determine whether the method will succeed by calling Chronicle.instance_service_available?.

About InstanceService

InstanceService provides the entry interface for the Chronicle API.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.instance_service_available?

def self.instance_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the InstanceService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.instance_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the InstanceService service, or if the versioned client gem needs an update to support the InstanceService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.native_dashboard_service

def self.native_dashboard_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for NativeDashboardService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::NativeDashboardService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the NativeDashboardService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the NativeDashboardService service. You can determine whether the method will succeed by calling Chronicle.native_dashboard_service_available?.

About NativeDashboardService

A service providing functionality for managing native dashboards.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.native_dashboard_service_available?

def self.native_dashboard_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the NativeDashboardService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.native_dashboard_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the NativeDashboardService service, or if the versioned client gem needs an update to support the NativeDashboardService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.reference_list_service

def self.reference_list_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for ReferenceListService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::ReferenceListService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ReferenceListService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the ReferenceListService service. You can determine whether the method will succeed by calling Chronicle.reference_list_service_available?.

About ReferenceListService

ReferenceListService provides an interface for managing reference lists.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.reference_list_service_available?

def self.reference_list_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the ReferenceListService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.reference_list_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ReferenceListService service, or if the versioned client gem needs an update to support the ReferenceListService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.rule_service

def self.rule_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for RuleService.

By default, this returns an instance of Google::Cloud::Chronicle::V1::RuleService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the RuleService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the RuleService service. You can determine whether the method will succeed by calling Chronicle.rule_service_available?.

About RuleService

RuleService provides interface for user-created rules.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.rule_service_available?

def self.rule_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the RuleService service is supported by the current client. If true, you can retrieve a client object by calling Chronicle.rule_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the RuleService service, or if the versioned client gem needs an update to support the RuleService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "0.4.0"