Chronicle V1 API - Class Google::Cloud::Chronicle::V1::DataTableService::Rest::Client (v0.5.0)

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

REST client for the DataTableService service.

DataTableManager provides an interface for managing data tables.

Inherits

  • Object

Includes

Methods

.configure

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

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

#bulk_create_data_table_rows

def bulk_create_data_table_rows(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BulkCreateDataTableRowsResponse
def bulk_create_data_table_rows(parent: nil, requests: nil) -> ::Google::Cloud::Chronicle::V1::BulkCreateDataTableRowsResponse

Create data table rows in bulk.

Overloads 
def bulk_create_data_table_rows(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BulkCreateDataTableRowsResponse
Pass arguments to bulk_create_data_table_rows via a request object, either of type BulkCreateDataTableRowsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::BulkCreateDataTableRowsRequest, ::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 bulk_create_data_table_rows(parent: nil, requests: nil) -> ::Google::Cloud::Chronicle::V1::BulkCreateDataTableRowsResponse
Pass arguments to bulk_create_data_table_rows 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 resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
  • requests (::Array<::Google::Cloud::Chronicle::V1::CreateDataTableRowRequest, ::Hash>) — Required. Data table rows to create. A maximum of 1000 rows (for sync requests) or 2000 rows (for async requests) can be created in a single request. Total size of the rows should be less than 4MB.
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::DataTableService::Rest::Client.new

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

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

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

#bulk_get_data_table_rows

def bulk_get_data_table_rows(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BulkGetDataTableRowsResponse
def bulk_get_data_table_rows(parent: nil, requests: nil) -> ::Google::Cloud::Chronicle::V1::BulkGetDataTableRowsResponse

Get data table rows in bulk.

Overloads 
def bulk_get_data_table_rows(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BulkGetDataTableRowsResponse
Pass arguments to bulk_get_data_table_rows via a request object, either of type BulkGetDataTableRowsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::BulkGetDataTableRowsRequest, ::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 bulk_get_data_table_rows(parent: nil, requests: nil) -> ::Google::Cloud::Chronicle::V1::BulkGetDataTableRowsResponse
Pass arguments to bulk_get_data_table_rows 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 resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
  • requests (::Array<::Google::Cloud::Chronicle::V1::GetDataTableRowRequest, ::Hash>) — Required. Data table rows to get. At max 1,000 rows can be there in a request.
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::DataTableService::Rest::Client.new

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

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

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

#bulk_replace_data_table_rows

def bulk_replace_data_table_rows(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BulkReplaceDataTableRowsResponse
def bulk_replace_data_table_rows(parent: nil, requests: nil) -> ::Google::Cloud::Chronicle::V1::BulkReplaceDataTableRowsResponse

Replace all existing data table rows with new data table rows.

Overloads 
def bulk_replace_data_table_rows(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BulkReplaceDataTableRowsResponse
Pass arguments to bulk_replace_data_table_rows via a request object, either of type BulkReplaceDataTableRowsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::BulkReplaceDataTableRowsRequest, ::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 bulk_replace_data_table_rows(parent: nil, requests: nil) -> ::Google::Cloud::Chronicle::V1::BulkReplaceDataTableRowsResponse
Pass arguments to bulk_replace_data_table_rows 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 resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
  • requests (::Array<::Google::Cloud::Chronicle::V1::CreateDataTableRowRequest, ::Hash>) — Required. Data table rows to replace the existing data table rows. A maximum of 1000 rows (for sync requests) or 2000 rows (for async requests) can be replaced in a single request. Total size of the rows should be less than 4MB.
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::DataTableService::Rest::Client.new

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

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

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

#bulk_update_data_table_rows

def bulk_update_data_table_rows(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BulkUpdateDataTableRowsResponse
def bulk_update_data_table_rows(parent: nil, requests: nil) -> ::Google::Cloud::Chronicle::V1::BulkUpdateDataTableRowsResponse

Update data table rows in bulk.

Overloads 
def bulk_update_data_table_rows(request, options = nil) -> ::Google::Cloud::Chronicle::V1::BulkUpdateDataTableRowsResponse
Pass arguments to bulk_update_data_table_rows via a request object, either of type BulkUpdateDataTableRowsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::BulkUpdateDataTableRowsRequest, ::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 bulk_update_data_table_rows(parent: nil, requests: nil) -> ::Google::Cloud::Chronicle::V1::BulkUpdateDataTableRowsResponse
Pass arguments to bulk_update_data_table_rows 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 resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
  • requests (::Array<::Google::Cloud::Chronicle::V1::UpdateDataTableRowRequest, ::Hash>) — Required. Data table rows to update. At max 1,000 rows (or rows with size less than 2MB) can be there in a request.
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::DataTableService::Rest::Client.new

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

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

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

#configure

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

Configure the DataTableService 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_data_table

def create_data_table(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTable
def create_data_table(parent: nil, data_table: nil, data_table_id: nil) -> ::Google::Cloud::Chronicle::V1::DataTable

Create a new data table.

Overloads 
def create_data_table(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTable
Pass arguments to create_data_table via a request object, either of type CreateDataTableRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::CreateDataTableRequest, ::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_data_table(parent: nil, data_table: nil, data_table_id: nil) -> ::Google::Cloud::Chronicle::V1::DataTable
Pass arguments to create_data_table 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 data table will be created. Format: projects/{project}/locations/{location}/instances/{instance}
  • data_table (::Google::Cloud::Chronicle::V1::DataTable, ::Hash) — Required. The data table being created.
  • data_table_id (::String) —

    Required. The ID to use for the data table. This is also the display name for the data table. It must satisfy the following requirements:

    • Starts with letter.
    • Contains only letters, numbers and underscore.
    • Must be unique and has length < 256.
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::DataTableService::Rest::Client.new

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

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

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

#create_data_table_row

def create_data_table_row(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow
def create_data_table_row(parent: nil, data_table_row: nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow

Create a new data table row.

Overloads 
def create_data_table_row(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow
Pass arguments to create_data_table_row via a request object, either of type CreateDataTableRowRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::CreateDataTableRowRequest, ::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_data_table_row(parent: nil, data_table_row: nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow
Pass arguments to create_data_table_row 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 resource id of the data table. Format: /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
  • data_table_row (::Google::Cloud::Chronicle::V1::DataTableRow, ::Hash) — Required. The data table row 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::DataTableService::Rest::Client.new

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

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

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

#delete_data_table

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

Delete data table.

Overloads 
def delete_data_table(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_table via a request object, either of type Google::Cloud::Chronicle::V1::DeleteDataTableRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::DeleteDataTableRequest, ::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_data_table(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_table 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 data table to delete. Format projects/{project}/locations/{location}/instances/{instances}/dataTables/{data_table}
  • force (::Boolean) — Optional. If set to true, any rows under this data table will also be deleted. (Otherwise, the request will only work if the data table has no rows.)
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::DataTableService::Rest::Client.new

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

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

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

#delete_data_table_row

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

Delete data table row.

Overloads 
def delete_data_table_row(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_table_row via a request object, either of type Google::Cloud::Chronicle::V1::DeleteDataTableRowRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::DeleteDataTableRowRequest, ::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_data_table_row(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_table_row 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 data table row i,e row_id. Format: projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
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::DataTableService::Rest::Client.new

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

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

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

#get_data_table

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

Get data table info.

Overloads 
def get_data_table(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTable
Pass arguments to get_data_table via a request object, either of type GetDataTableRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetDataTableRequest, ::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_data_table(name: nil) -> ::Google::Cloud::Chronicle::V1::DataTable
Pass arguments to get_data_table 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 data table to retrieve. Format: projects/{project}/locations/{location}/instances/{instances}/dataTables/{data_table}
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::DataTableService::Rest::Client.new

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

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

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

#get_data_table_operation_errors

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

Get the error for a data table operation.

Overloads 
def get_data_table_operation_errors(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTableOperationErrors
Pass arguments to get_data_table_operation_errors via a request object, either of type GetDataTableOperationErrorsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetDataTableOperationErrorsRequest, ::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_data_table_operation_errors(name: nil) -> ::Google::Cloud::Chronicle::V1::DataTableOperationErrors
Pass arguments to get_data_table_operation_errors 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. Resource name for the data table operation errors. Format: projects/{project}/locations/{location}/instances/{instance}/dataTableOperationErrors/{data_table_operation_errors}
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::DataTableService::Rest::Client.new

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

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

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

#get_data_table_row

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

Get data table row

Overloads 
def get_data_table_row(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow
Pass arguments to get_data_table_row via a request object, either of type GetDataTableRowRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetDataTableRowRequest, ::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_data_table_row(name: nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow
Pass arguments to get_data_table_row 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 data table row i,e row_id. Format: projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
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::DataTableService::Rest::Client.new

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

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

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

#initialize

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

Create a new DataTableService REST client object.

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

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

#list_data_table_rows

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

List data table rows.

Overloads 
def list_data_table_rows(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataTableRow>
Pass arguments to list_data_table_rows via a request object, either of type ListDataTableRowsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ListDataTableRowsRequest, ::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_data_table_rows(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataTableRow>
Pass arguments to list_data_table_rows 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 resource id of the data table. Format: projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table}
  • page_size (::Integer) — Optional. The maximum number of data table rows to return. The service may return fewer than this value. If unspecified, at most 100 data table rows will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A page token, received from a previous ListDataTableRows call.
  • order_by (::String) — Optional. Configures ordering of DataTables in the response. Note: Our implementation currently supports order by "create_time asc" only
  • filter (::String) — Optional. Filter facilitating search over data table rows. This filter performs a case-insensitive substring match on the row values.
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::DataTableService::Rest::Client.new

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

# Call the list_data_table_rows method.
result = client.list_data_table_rows 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::DataTableRow.
  p item
end

#list_data_tables

def list_data_tables(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataTable>
def list_data_tables(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataTable>

List data tables.

Overloads 
def list_data_tables(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataTable>
Pass arguments to list_data_tables via a request object, either of type ListDataTablesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ListDataTablesRequest, ::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_data_tables(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataTable>
Pass arguments to list_data_tables 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 data table will be created. Format: projects/{project}/locations/{location}/instances/{instance}
  • page_size (::Integer) — Optional. The maximum number of data tables to return. The service may return fewer than this value. If unspecified, at most 100 data tables will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A page token, received from a previous ListDataTables call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTables must match the call that provided the page token.
  • order_by (::String) — Optional. Configures ordering of DataTables in the response. Note: Our implementation currently supports order by "create_time asc" only
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::DataTableService::Rest::Client.new

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

# Call the list_data_tables method.
result = client.list_data_tables 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::DataTable.
  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)

#update_data_table

def update_data_table(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTable
def update_data_table(data_table: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::DataTable

Update data table.

Overloads 
def update_data_table(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTable
Pass arguments to update_data_table via a request object, either of type UpdateDataTableRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::UpdateDataTableRequest, ::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_data_table(data_table: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::DataTable
Pass arguments to update_data_table 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
  • data_table (::Google::Cloud::Chronicle::V1::DataTable, ::Hash) — Required. This field is used to identify the datatable to update. Format: projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table}
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of metadata fields to update. Currently data tables only support updating the description, row_time_to_live and scope_info fields. When no field mask is supplied, all non-empty fields will be updated. A field mask of "*" will update all fields, whether empty or not.
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::DataTableService::Rest::Client.new

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

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

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

#update_data_table_row

def update_data_table_row(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow
def update_data_table_row(data_table_row: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow

Update data table row

Overloads 
def update_data_table_row(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow
Pass arguments to update_data_table_row via a request object, either of type UpdateDataTableRowRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::UpdateDataTableRowRequest, ::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_data_table_row(data_table_row: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::DataTableRow
Pass arguments to update_data_table_row 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
  • data_table_row (::Google::Cloud::Chronicle::V1::DataTableRow, ::Hash) — Required. Format: projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update. Currently data table rows only support updating the values field. When no field mask is supplied, all non-empty fields will be updated. A field mask of "*" will update all fields, whether empty or not.
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::DataTableService::Rest::Client.new

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

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

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