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

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

Client for the UserStoreService service.

Service for managing User Stores.

Inherits

  • Object

Includes

Methods

.configure

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

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

#configure

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

Configure the UserStoreService 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_user_store

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

Gets the User Store.

Overloads 
def get_user_store(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserStore
Pass arguments to get_user_store via a request object, either of type GetUserStoreRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1beta::GetUserStoreRequest, ::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_user_store(name: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserStore
Pass arguments to get_user_store 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 name of the User Store to get. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
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::UserStoreService::Client.new

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

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

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

#initialize

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

Create a new UserStoreService client object.

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

# Create a client using a custom configuration
client = ::Google::Cloud::DiscoveryEngine::V1beta::UserStoreService::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_user_store

def update_user_store(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserStore
def update_user_store(user_store: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserStore

Updates the User Store.

Overloads 
def update_user_store(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserStore
Pass arguments to update_user_store via a request object, either of type Google::Cloud::DiscoveryEngine::V1beta::UpdateUserStoreRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1beta::UpdateUserStoreRequest, ::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_user_store(user_store: nil, update_mask: nil) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserStore
Pass arguments to update_user_store 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
  • (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::UserStoreService::Client.new

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

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

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