Discovery Engine v1beta API - Class UserStoreServiceClient (1.0.0-beta24)

1.0.0-beta24 (latest) 1.0.0-beta23

public abstract class UserStoreServiceClient

Reference documentation and code samples for the Discovery Engine v1beta API class UserStoreServiceClient.

UserStoreService client wrapper, for convenient use.

Inheritance

object > UserStoreServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

UserStoreServiceClientImpl

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Remarks

Service for managing User Stores.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the UserStoreService service, which is a host of "discoveryengine.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default UserStoreService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default UserStoreService scopes are:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/discoveryengine.readwrite
• https://www.googleapis.com/auth/discoveryengine.serving.readwrite

GrpcClient

public virtual UserStoreService.UserStoreServiceClient GrpcClient { get; }

The underlying gRPC UserStoreService client

Property Value
Type	Description
UserStoreServiceUserStoreServiceClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static UserStoreServiceClient Create()

Synchronously creates a UserStoreServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use UserStoreServiceClientBuilder.

Returns
Type	Description
UserStoreServiceClient	The created UserStoreServiceClient.

CreateAsync(CancellationToken)

public static Task<UserStoreServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a UserStoreServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use UserStoreServiceClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskUserStoreServiceClient	The task representing the created UserStoreServiceClient.

GetUserStore(GetUserStoreRequest, CallSettings)

public virtual UserStore GetUserStore(GetUserStoreRequest request, CallSettings callSettings = null)

Gets the User Store.

Parameters
Name	Description
request	GetUserStoreRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
UserStore	The RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = UserStoreServiceClient.Create();
// Initialize request argument(s)
GetUserStoreRequest request = new GetUserStoreRequest
{
    UserStoreName = UserStoreName.FromProjectLocationUserStore("[PROJECT]", "[LOCATION]", "[USER_STORE]"),
};
// Make the request
UserStore response = userStoreServiceClient.GetUserStore(request);

GetUserStore(UserStoreName, CallSettings)

public virtual UserStore GetUserStore(UserStoreName name, CallSettings callSettings = null)

Gets the User Store.

Parameters
Name	Description
name	UserStoreName Required. The name of the User Store to get. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
UserStore	The RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = UserStoreServiceClient.Create();
// Initialize request argument(s)
UserStoreName name = UserStoreName.FromProjectLocationUserStore("[PROJECT]", "[LOCATION]", "[USER_STORE]");
// Make the request
UserStore response = userStoreServiceClient.GetUserStore(name);

GetUserStore(string, CallSettings)

public virtual UserStore GetUserStore(string name, CallSettings callSettings = null)

Gets the User Store.

Parameters
Name	Description
name	string Required. The name of the User Store to get. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
UserStore	The RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = UserStoreServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/userStores/[USER_STORE]";
// Make the request
UserStore response = userStoreServiceClient.GetUserStore(name);

GetUserStoreAsync(GetUserStoreRequest, CallSettings)

public virtual Task<UserStore> GetUserStoreAsync(GetUserStoreRequest request, CallSettings callSettings = null)

Gets the User Store.

Parameters
Name	Description
request	GetUserStoreRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserStoreRequest request = new GetUserStoreRequest
{
    UserStoreName = UserStoreName.FromProjectLocationUserStore("[PROJECT]", "[LOCATION]", "[USER_STORE]"),
};
// Make the request
UserStore response = await userStoreServiceClient.GetUserStoreAsync(request);

GetUserStoreAsync(GetUserStoreRequest, CancellationToken)

public virtual Task<UserStore> GetUserStoreAsync(GetUserStoreRequest request, CancellationToken cancellationToken)

Gets the User Store.

Parameters
Name	Description
request	GetUserStoreRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserStoreRequest request = new GetUserStoreRequest
{
    UserStoreName = UserStoreName.FromProjectLocationUserStore("[PROJECT]", "[LOCATION]", "[USER_STORE]"),
};
// Make the request
UserStore response = await userStoreServiceClient.GetUserStoreAsync(request);

GetUserStoreAsync(UserStoreName, CallSettings)

public virtual Task<UserStore> GetUserStoreAsync(UserStoreName name, CallSettings callSettings = null)

Gets the User Store.

Parameters
Name	Description
name	UserStoreName Required. The name of the User Store to get. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
UserStoreName name = UserStoreName.FromProjectLocationUserStore("[PROJECT]", "[LOCATION]", "[USER_STORE]");
// Make the request
UserStore response = await userStoreServiceClient.GetUserStoreAsync(name);

GetUserStoreAsync(UserStoreName, CancellationToken)

public virtual Task<UserStore> GetUserStoreAsync(UserStoreName name, CancellationToken cancellationToken)

Gets the User Store.

Parameters
Name	Description
name	UserStoreName Required. The name of the User Store to get. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
UserStoreName name = UserStoreName.FromProjectLocationUserStore("[PROJECT]", "[LOCATION]", "[USER_STORE]");
// Make the request
UserStore response = await userStoreServiceClient.GetUserStoreAsync(name);

GetUserStoreAsync(string, CallSettings)

public virtual Task<UserStore> GetUserStoreAsync(string name, CallSettings callSettings = null)

Gets the User Store.

Parameters
Name	Description
name	string Required. The name of the User Store to get. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/userStores/[USER_STORE]";
// Make the request
UserStore response = await userStoreServiceClient.GetUserStoreAsync(name);

GetUserStoreAsync(string, CancellationToken)

public virtual Task<UserStore> GetUserStoreAsync(string name, CancellationToken cancellationToken)

Gets the User Store.

Parameters
Name	Description
name	string Required. The name of the User Store to get. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/userStores/[USER_STORE]";
// Make the request
UserStore response = await userStoreServiceClient.GetUserStoreAsync(name);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateUserStore(UpdateUserStoreRequest, CallSettings)

public virtual UserStore UpdateUserStore(UpdateUserStoreRequest request, CallSettings callSettings = null)

Updates the User Store.

Parameters
Name	Description
request	UpdateUserStoreRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
UserStore	The RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = UserStoreServiceClient.Create();
// Initialize request argument(s)
UpdateUserStoreRequest request = new UpdateUserStoreRequest
{
    UserStore = new UserStore(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserStore response = userStoreServiceClient.UpdateUserStore(request);

UpdateUserStore(UserStore, FieldMask, CallSettings)

public virtual UserStore UpdateUserStore(UserStore userStore, FieldMask updateMask, CallSettings callSettings = null)

Updates the User Store.

Parameters
Name	Description
userStore	UserStore Required. The User Store to update. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
updateMask	FieldMask Optional. The list of fields to update.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
UserStore	The RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = UserStoreServiceClient.Create();
// Initialize request argument(s)
UserStore userStore = new UserStore();
FieldMask updateMask = new FieldMask();
// Make the request
UserStore response = userStoreServiceClient.UpdateUserStore(userStore, updateMask);

UpdateUserStoreAsync(UpdateUserStoreRequest, CallSettings)

public virtual Task<UserStore> UpdateUserStoreAsync(UpdateUserStoreRequest request, CallSettings callSettings = null)

Updates the User Store.

Parameters
Name	Description
request	UpdateUserStoreRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserStoreRequest request = new UpdateUserStoreRequest
{
    UserStore = new UserStore(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserStore response = await userStoreServiceClient.UpdateUserStoreAsync(request);

UpdateUserStoreAsync(UpdateUserStoreRequest, CancellationToken)

public virtual Task<UserStore> UpdateUserStoreAsync(UpdateUserStoreRequest request, CancellationToken cancellationToken)

Updates the User Store.

Parameters
Name	Description
request	UpdateUserStoreRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserStoreRequest request = new UpdateUserStoreRequest
{
    UserStore = new UserStore(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserStore response = await userStoreServiceClient.UpdateUserStoreAsync(request);

UpdateUserStoreAsync(UserStore, FieldMask, CallSettings)

public virtual Task<UserStore> UpdateUserStoreAsync(UserStore userStore, FieldMask updateMask, CallSettings callSettings = null)

Updates the User Store.

Parameters
Name	Description
userStore	UserStore Required. The User Store to update. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
updateMask	FieldMask Optional. The list of fields to update.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
UserStore userStore = new UserStore();
FieldMask updateMask = new FieldMask();
// Make the request
UserStore response = await userStoreServiceClient.UpdateUserStoreAsync(userStore, updateMask);

UpdateUserStoreAsync(UserStore, FieldMask, CancellationToken)

public virtual Task<UserStore> UpdateUserStoreAsync(UserStore userStore, FieldMask updateMask, CancellationToken cancellationToken)

Updates the User Store.

Parameters
Name	Description
userStore	UserStore Required. The User Store to update. Format: projects/{project}/locations/{location}/userStores/{user_store_id}
updateMask	FieldMask Optional. The list of fields to update.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskUserStore	A Task containing the RPC response.

Example

// Create client
UserStoreServiceClient userStoreServiceClient = await UserStoreServiceClient.CreateAsync();
// Initialize request argument(s)
UserStore userStore = new UserStore();
FieldMask updateMask = new FieldMask();
// Make the request
UserStore response = await userStoreServiceClient.UpdateUserStoreAsync(userStore, updateMask);