Chronicle V1 API - Class Google::Cloud::Chronicle::V1::DataAccessControlService::Rest::Client (v0.1.0)

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

REST client for the DataAccessControlService service.

DataAccessControlService exposes resources and endpoints related to data access control.

Inherits

  • Object

Includes

Methods

.configure

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

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

#configure

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

Configure the DataAccessControlService 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_access_label

def create_data_access_label(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel
def create_data_access_label(parent: nil, data_access_label: nil, data_access_label_id: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel

Creates a data access label. Data access labels are applied to incoming event data and selected in data access scopes (another resource), and only users with scopes containing the label can see data with that label. Currently, the data access label resource only includes custom labels, which are labels that correspond to UDM queries over event data.

Overloads 
def create_data_access_label(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel
Pass arguments to create_data_access_label via a request object, either of type CreateDataAccessLabelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::CreateDataAccessLabelRequest, ::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_access_label(parent: nil, data_access_label: nil, data_access_label_id: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel
Pass arguments to create_data_access_label 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 Access Label will be created. Format: projects/{project}/locations/{location}/instances/{instance}
  • data_access_label (::Google::Cloud::Chronicle::V1::DataAccessLabel, ::Hash) — Required. Data access label to create.
  • data_access_label_id (::String) — Required. The ID to use for the data access label, which will become the label's display name and the final component of the label's resource name. The maximum number of characters should be 63. Regex pattern is as per AIP: https://google.aip.dev/122#resource-id-segments
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::DataAccessControlService::Rest::Client.new

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

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

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

#create_data_access_scope

def create_data_access_scope(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
def create_data_access_scope(parent: nil, data_access_scope: nil, data_access_scope_id: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope

Creates a data access scope. Data access scope is a combination of allowed and denied labels attached to a permission group. If a scope has allowed labels A and B and denied labels C and D, then the group of people attached to the scope will have permissions to see all events labeled with A or B (or both) and not labeled with either C or D.

Overloads 
def create_data_access_scope(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
Pass arguments to create_data_access_scope via a request object, either of type CreateDataAccessScopeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::CreateDataAccessScopeRequest, ::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_access_scope(parent: nil, data_access_scope: nil, data_access_scope_id: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
Pass arguments to create_data_access_scope 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 Access Scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}
  • data_access_scope (::Google::Cloud::Chronicle::V1::DataAccessScope, ::Hash) — Required. Data access scope to create.
  • data_access_scope_id (::String) — Required. The user provided scope id which will become the last part of the name of the scope resource. Needs to be compliant with https://google.aip.dev/122
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::DataAccessControlService::Rest::Client.new

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

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

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

#delete_data_access_label

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

Deletes a data access label. When a label is deleted, new data that enters in the system will not receive the label, but the label will not be removed from old data that still refers to it.

Overloads 
def delete_data_access_label(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_access_label via a request object, either of type Google::Cloud::Chronicle::V1::DeleteDataAccessLabelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::DeleteDataAccessLabelRequest, ::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_access_label(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_access_label 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 ID of the data access label to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}
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::DataAccessControlService::Rest::Client.new

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

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

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

#delete_data_access_scope

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

Deletes a data access scope.

Overloads 
def delete_data_access_scope(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_access_scope via a request object, either of type Google::Cloud::Chronicle::V1::DeleteDataAccessScopeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::DeleteDataAccessScopeRequest, ::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_access_scope(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_data_access_scope 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 ID of the data access scope to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}
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::DataAccessControlService::Rest::Client.new

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

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

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

#get_data_access_label

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

Gets a data access label.

Overloads 
def get_data_access_label(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel
Pass arguments to get_data_access_label via a request object, either of type GetDataAccessLabelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetDataAccessLabelRequest, ::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_access_label(name: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel
Pass arguments to get_data_access_label 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 ID of the data access label to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}
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::DataAccessControlService::Rest::Client.new

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

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

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

#get_data_access_scope

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

Retrieves an existing data access scope.

Overloads 
def get_data_access_scope(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
Pass arguments to get_data_access_scope via a request object, either of type GetDataAccessScopeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::GetDataAccessScopeRequest, ::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_access_scope(name: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
Pass arguments to get_data_access_scope 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 ID of the data access scope to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}
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::DataAccessControlService::Rest::Client.new

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

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

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

#initialize

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

Create a new DataAccessControlService REST client object.

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

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

#list_data_access_labels

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

Lists all data access labels for the customer.

Overloads 
def list_data_access_labels(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataAccessLabel>
Pass arguments to list_data_access_labels via a request object, either of type ListDataAccessLabelsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ListDataAccessLabelsRequest, ::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_access_labels(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataAccessLabel>
Pass arguments to list_data_access_labels 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 access label will be created. Format: projects/{project}/locations/{location}/instances/{instance}
  • page_size (::Integer) — The maximum number of data access labels to return. The service may return fewer than this value. If unspecified, at most 100 data access labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListDataAccessLabelsRequest call. Provide this to retrieve the subsequent page.
  • filter (::String) — Optional. A filter which should follow the guidelines of AIP-160. Supports filtering on all fieds of DataAccessLabel and all operations as mentioned in https://google.aip.dev/160. example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR display_name:\"-21-1\"".
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::DataAccessControlService::Rest::Client.new

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

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

#list_data_access_scopes

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

Lists all existing data access scopes for the customer.

Overloads 
def list_data_access_scopes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataAccessScope>
Pass arguments to list_data_access_scopes via a request object, either of type ListDataAccessScopesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::ListDataAccessScopesRequest, ::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_access_scopes(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Chronicle::V1::DataAccessScope>
Pass arguments to list_data_access_scopes 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 access scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}
  • page_size (::Integer) — The maximum number of data access scopes to return. The service may return fewer than this value. If unspecified, at most 100 data access scopes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — A page token, received from a previous ListDataAccessScopesRequest call. Provide this to retrieve the subsequent page.
  • filter (::String) — Optional. A filter which should follow the guidelines of AIP-160. Supports filtering on all fieds of DataAccessScope and all operations as mentioned in https://google.aip.dev/160. example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR display_name:\"-21-1\"".
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::DataAccessControlService::Rest::Client.new

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

# Call the list_data_access_scopes method.
result = client.list_data_access_scopes 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::DataAccessScope.
  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_access_label

def update_data_access_label(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel
def update_data_access_label(data_access_label: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel

Updates a data access label.

Overloads 
def update_data_access_label(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel
Pass arguments to update_data_access_label via a request object, either of type UpdateDataAccessLabelRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::UpdateDataAccessLabelRequest, ::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_access_label(data_access_label: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessLabel
Pass arguments to update_data_access_label 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_access_label (::Google::Cloud::Chronicle::V1::DataAccessLabel, ::Hash) — Required. The data access label to update.

    The label's name field is used to identify the label to update. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to update. If not included, all fields with a non-empty value will be overwritten. Currently, only the description and definition fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT.
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::DataAccessControlService::Rest::Client.new

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

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

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

#update_data_access_scope

def update_data_access_scope(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
def update_data_access_scope(data_access_scope: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope

Updates a data access scope.

Overloads 
def update_data_access_scope(request, options = nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
Pass arguments to update_data_access_scope via a request object, either of type UpdateDataAccessScopeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Chronicle::V1::UpdateDataAccessScopeRequest, ::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_access_scope(data_access_scope: nil, update_mask: nil) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
Pass arguments to update_data_access_scope 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_access_scope (::Google::Cloud::Chronicle::V1::DataAccessScope, ::Hash) — Required. The data access scope to update.

    The scope's name field is used to identify the scope to update. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to update. If not included, all fields with a non-empty value will be overwritten. Currently, only the description, the allowed and denied labels list fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT.
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::DataAccessControlService::Rest::Client.new

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

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

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