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

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

REST client for the BigQueryExportService service.

Service for managing BigQuery export configurations for Chronicle instances.

Inherits

  • Object

Includes

Methods

.configure

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

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

#configure

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

Configure the BigQueryExportService 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_big_query_export

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

Get the BigQuery export configuration for a Chronicle instance.

Overloads 
def get_big_query_export(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport
Pass arguments to get_big_query_export via a request object, either of type GetBigQueryExportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetBigQueryExportRequest, ::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_big_query_export(name: nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport
Pass arguments to get_big_query_export 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 BigqueryExport to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/bigQueryExport
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::BigQueryExportService::Rest::Client.new

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

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

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

#initialize

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

Create a new BigQueryExportService REST client object.

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

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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#provision_big_query_export

def provision_big_query_export(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport
def provision_big_query_export(parent: nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport

Provision the BigQuery export for a Chronicle instance. This will create {{gcp_name}} resources like {{storage_name}} buckets, BigQuery datasets and set default export settings for each data source.

Overloads 
def provision_big_query_export(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport
Pass arguments to provision_big_query_export via a request object, either of type ProvisionBigQueryExportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ProvisionBigQueryExportRequest, ::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 provision_big_query_export(parent: nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport
Pass arguments to provision_big_query_export 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
  • parent (::String) — Required. The instance for which BigQuery export is being provisioned. Format: projects/{project}/locations/{location}/instances/{instance}
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::BigQueryExportService::Rest::Client.new

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

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

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_big_query_export

def update_big_query_export(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport
def update_big_query_export(big_query_export: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport

Update the BigQuery export configuration for a Chronicle instance.

Overloads 
def update_big_query_export(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport
Pass arguments to update_big_query_export via a request object, either of type UpdateBigQueryExportRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::UpdateBigQueryExportRequest, ::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_big_query_export(big_query_export: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::BigQueryExport
Pass arguments to update_big_query_export 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::BigQueryExportService::Rest::Client.new

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

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

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