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

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::UserStoreService::Client.

Client for the UserStoreService service.


<br />

Service for managing User Stores.

## Inherits

- Object

## Includes

- [Google::Cloud::DiscoveryEngine::V1beta::UserStoreService::Paths](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Paths)

## Methods

### .configure

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

Configure the UserStoreService Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client-Configuration "Google::Cloud::DiscoveryEngine::V1beta::UserStoreService::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client-Configuration))
**Example**

```ruby
# 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client#Google__Cloud__DiscoveryEngine__V1beta__UserStoreService__Client_configure_class_ "Google::Cloud::DiscoveryEngine::V1beta::UserStoreService::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client-Configuration "Google::Cloud::DiscoveryEngine::V1beta::UserStoreService::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client-Configuration))

### #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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-GetUserStoreRequest "Google::Cloud::DiscoveryEngine::V1beta::GetUserStoreRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::DiscoveryEngine::V1beta::GetUserStoreRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/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**

- **response** ([::Google::Cloud::DiscoveryEngine::V1beta::UserStore](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStore))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::UserStore](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStore))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
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**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStoreService-Client)) --- a new instance of Client
**Example**

```ruby
# 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UpdateUserStoreRequest "Google::Cloud::DiscoveryEngine::V1beta::UpdateUserStoreRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::DiscoveryEngine::V1beta::UpdateUserStoreRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/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**

- **user_store** ([::Google::Cloud::DiscoveryEngine::V1beta::UserStore](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStore), ::Hash) --- Required. The User Store to update. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`
- **update_mask** ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Protobuf-FieldMask), ::Hash) --- Optional. The list of fields to update.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::DiscoveryEngine::V1beta::UserStore](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStore))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::UserStore](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserStore))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
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
```