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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

value: "0.1.0"