Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::AclConfigService::Client (v0.28.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::AclConfigService::Client.

Client for the AclConfigService service.

Service for managing Acl Configuration.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the AclConfigService 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 AclConfigService clients
::Google::Cloud::DiscoveryEngine::V1beta::AclConfigService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the AclConfigService 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_acl_config

def get_acl_config(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::AclConfig
def get_acl_config(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::AclConfig

Gets the AclConfig.

Overloads 
def get_acl_config(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::AclConfig
Pass arguments to get_acl_config via a request object, either of type GetAclConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1beta::GetAclConfigRequest, ::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_acl_config(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::AclConfig
Pass arguments to get_acl_config 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 of AclConfig, such as projects/*/locations/*/aclConfig.

    If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DiscoveryEngine::V1beta::AclConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DiscoveryEngine::V1beta::GetAclConfigRequest.new

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

# The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::AclConfig.
p result

#initialize

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

Create a new AclConfigService client object.

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

# Create a client using a custom configuration
client = ::Google::Cloud::DiscoveryEngine::V1beta::AclConfigService::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#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_acl_config

def update_acl_config(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::AclConfig
def update_acl_config(acl_config: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::AclConfig

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

Overloads 
def update_acl_config(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::AclConfig
Pass arguments to update_acl_config via a request object, either of type UpdateAclConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1beta::UpdateAclConfigRequest, ::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_acl_config(acl_config: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::AclConfig
Pass arguments to update_acl_config 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
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DiscoveryEngine::V1beta::AclConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DiscoveryEngine::V1beta::UpdateAclConfigRequest.new

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

# The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::AclConfig.
p result