Discovery Engine v1 API - Class ServingConfigServiceClient (1.7.0) 

public abstract class ServingConfigServiceClient

Reference documentation and code samples for the Discovery Engine v1 API class ServingConfigServiceClient.

ServingConfigService client wrapper, for convenient use.

Inheritance

object > ServingConfigServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for operations related to [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig].

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ServingConfigService 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 ServingConfigService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default ServingConfigService scopes are:

GrpcClient

public virtual ServingConfigService.ServingConfigServiceClient GrpcClient { get; }

The underlying gRPC ServingConfigService client

Property Value
Type Description
ServingConfigServiceServingConfigServiceClient

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 ServingConfigServiceClient Create()

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

Returns
Type Description
ServingConfigServiceClient

The created ServingConfigServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskServingConfigServiceClient

The task representing the created ServingConfigServiceClient.

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.

UpdateServingConfig(ServingConfig, FieldMask, CallSettings)

public virtual ServingConfig UpdateServingConfig(ServingConfig servingConfig, FieldMask updateMask, CallSettings callSettings = null)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Parameters
Name Description
servingConfig ServingConfig

Required. The ServingConfig to update.
updateMask FieldMask

Indicates which fields in the provided [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to update. The following are NOT supported:

  • [ServingConfig.name][google.cloud.discoveryengine.v1.ServingConfig.name]

If not set, all supported fields are updated.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ServingConfig

The RPC response.
Example 
// Create client
ServingConfigServiceClient servingConfigServiceClient = ServingConfigServiceClient.Create();
// Initialize request argument(s)
ServingConfig servingConfig = new ServingConfig();
FieldMask updateMask = new FieldMask();
// Make the request
ServingConfig response = servingConfigServiceClient.UpdateServingConfig(servingConfig, updateMask);

UpdateServingConfig(UpdateServingConfigRequest, CallSettings)

public virtual ServingConfig UpdateServingConfig(UpdateServingConfigRequest request, CallSettings callSettings = null)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Parameters
Name Description
request UpdateServingConfigRequest

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
ServingConfig

The RPC response.
Example 
// Create client
ServingConfigServiceClient servingConfigServiceClient = ServingConfigServiceClient.Create();
// Initialize request argument(s)
UpdateServingConfigRequest request = new UpdateServingConfigRequest
{
    ServingConfig = new ServingConfig(),
    UpdateMask = new FieldMask(),
};
// Make the request
ServingConfig response = servingConfigServiceClient.UpdateServingConfig(request);

UpdateServingConfigAsync(ServingConfig, FieldMask, CallSettings)

public virtual Task<ServingConfig> UpdateServingConfigAsync(ServingConfig servingConfig, FieldMask updateMask, CallSettings callSettings = null)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Parameters
Name Description
servingConfig ServingConfig

Required. The ServingConfig to update.
updateMask FieldMask

Indicates which fields in the provided [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to update. The following are NOT supported:

  • [ServingConfig.name][google.cloud.discoveryengine.v1.ServingConfig.name]

If not set, all supported fields are updated.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskServingConfig

A Task containing the RPC response.
Example 
// Create client
ServingConfigServiceClient servingConfigServiceClient = await ServingConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ServingConfig servingConfig = new ServingConfig();
FieldMask updateMask = new FieldMask();
// Make the request
ServingConfig response = await servingConfigServiceClient.UpdateServingConfigAsync(servingConfig, updateMask);

UpdateServingConfigAsync(ServingConfig, FieldMask, CancellationToken)

public virtual Task<ServingConfig> UpdateServingConfigAsync(ServingConfig servingConfig, FieldMask updateMask, CancellationToken cancellationToken)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Parameters
Name Description
servingConfig ServingConfig

Required. The ServingConfig to update.
updateMask FieldMask

Indicates which fields in the provided [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to update. The following are NOT supported:

  • [ServingConfig.name][google.cloud.discoveryengine.v1.ServingConfig.name]

If not set, all supported fields are updated.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskServingConfig

A Task containing the RPC response.
Example 
// Create client
ServingConfigServiceClient servingConfigServiceClient = await ServingConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ServingConfig servingConfig = new ServingConfig();
FieldMask updateMask = new FieldMask();
// Make the request
ServingConfig response = await servingConfigServiceClient.UpdateServingConfigAsync(servingConfig, updateMask);

UpdateServingConfigAsync(UpdateServingConfigRequest, CallSettings)

public virtual Task<ServingConfig> UpdateServingConfigAsync(UpdateServingConfigRequest request, CallSettings callSettings = null)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Parameters
Name Description
request UpdateServingConfigRequest

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
TaskServingConfig

A Task containing the RPC response.
Example 
// Create client
ServingConfigServiceClient servingConfigServiceClient = await ServingConfigServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateServingConfigRequest request = new UpdateServingConfigRequest
{
    ServingConfig = new ServingConfig(),
    UpdateMask = new FieldMask(),
};
// Make the request
ServingConfig response = await servingConfigServiceClient.UpdateServingConfigAsync(request);

UpdateServingConfigAsync(UpdateServingConfigRequest, CancellationToken)

public virtual Task<ServingConfig> UpdateServingConfigAsync(UpdateServingConfigRequest request, CancellationToken cancellationToken)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

Parameters
Name Description
request UpdateServingConfigRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskServingConfig

A Task containing the RPC response.
Example 
// Create client
ServingConfigServiceClient servingConfigServiceClient = await ServingConfigServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateServingConfigRequest request = new UpdateServingConfigRequest
{
    ServingConfig = new ServingConfig(),
    UpdateMask = new FieldMask(),
};
// Make the request
ServingConfig response = await servingConfigServiceClient.UpdateServingConfigAsync(request);