Discovery Engine v1beta API - Class ServingConfigServiceClient (1.0.0-beta15)

public abstract class ServingConfigServiceClient

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

ServingConfigService client wrapper, for convenient use.

Inheritance

object > ServingConfigServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Remarks

Service for operations related to [ServingConfig][google.cloud.discoveryengine.v1beta.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.

GetServingConfig(GetServingConfigRequest, CallSettings)

public virtual ServingConfig GetServingConfig(GetServingConfigRequest request, CallSettings callSettings = null)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
request GetServingConfigRequest

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)
GetServingConfigRequest request = new GetServingConfigRequest
{
    ServingConfigName = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]"),
};
// Make the request
ServingConfig response = servingConfigServiceClient.GetServingConfig(request);

GetServingConfig(ServingConfigName, CallSettings)

public virtual ServingConfig GetServingConfig(ServingConfigName name, CallSettings callSettings = null)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
name ServingConfigName

Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

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)
ServingConfigName name = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]");
// Make the request
ServingConfig response = servingConfigServiceClient.GetServingConfig(name);

GetServingConfig(string, CallSettings)

public virtual ServingConfig GetServingConfig(string name, CallSettings callSettings = null)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
name string

Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

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)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataStores/[DATA_STORE]/servingConfigs/[SERVING_CONFIG]";
// Make the request
ServingConfig response = servingConfigServiceClient.GetServingConfig(name);

GetServingConfigAsync(GetServingConfigRequest, CallSettings)

public virtual Task<ServingConfig> GetServingConfigAsync(GetServingConfigRequest request, CallSettings callSettings = null)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
request GetServingConfigRequest

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)
GetServingConfigRequest request = new GetServingConfigRequest
{
    ServingConfigName = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]"),
};
// Make the request
ServingConfig response = await servingConfigServiceClient.GetServingConfigAsync(request);

GetServingConfigAsync(GetServingConfigRequest, CancellationToken)

public virtual Task<ServingConfig> GetServingConfigAsync(GetServingConfigRequest request, CancellationToken cancellationToken)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
request GetServingConfigRequest

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)
GetServingConfigRequest request = new GetServingConfigRequest
{
    ServingConfigName = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]"),
};
// Make the request
ServingConfig response = await servingConfigServiceClient.GetServingConfigAsync(request);

GetServingConfigAsync(ServingConfigName, CallSettings)

public virtual Task<ServingConfig> GetServingConfigAsync(ServingConfigName name, CallSettings callSettings = null)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
name ServingConfigName

Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

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)
ServingConfigName name = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]");
// Make the request
ServingConfig response = await servingConfigServiceClient.GetServingConfigAsync(name);

GetServingConfigAsync(ServingConfigName, CancellationToken)

public virtual Task<ServingConfig> GetServingConfigAsync(ServingConfigName name, CancellationToken cancellationToken)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
name ServingConfigName

Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

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)
ServingConfigName name = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]");
// Make the request
ServingConfig response = await servingConfigServiceClient.GetServingConfigAsync(name);

GetServingConfigAsync(string, CallSettings)

public virtual Task<ServingConfig> GetServingConfigAsync(string name, CallSettings callSettings = null)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
name string

Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

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)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataStores/[DATA_STORE]/servingConfigs/[SERVING_CONFIG]";
// Make the request
ServingConfig response = await servingConfigServiceClient.GetServingConfigAsync(name);

GetServingConfigAsync(string, CancellationToken)

public virtual Task<ServingConfig> GetServingConfigAsync(string name, CancellationToken cancellationToken)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters
Name Description
name string

Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

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)
string name = "projects/[PROJECT]/locations/[LOCATION]/dataStores/[DATA_STORE]/servingConfigs/[SERVING_CONFIG]";
// Make the request
ServingConfig response = await servingConfigServiceClient.GetServingConfigAsync(name);

ListServingConfigs(DataStoreName, string, int?, CallSettings)

public virtual PagedEnumerable<ListServingConfigsResponse, ServingConfig> ListServingConfigs(DataStoreName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ServingConfigs linked to this dataStore.

Parameters
Name Description
parent DataStoreName

Required. Full resource name of the parent resource. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListServingConfigsResponseServingConfig

A pageable sequence of ServingConfig resources.

Example
// Create client
ServingConfigServiceClient servingConfigServiceClient = ServingConfigServiceClient.Create();
// Initialize request argument(s)
DataStoreName parent = DataStoreName.FromProjectLocationDataStore("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
// Make the request
PagedEnumerable<ListServingConfigsResponse, ServingConfig> response = servingConfigServiceClient.ListServingConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ServingConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListServingConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ServingConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ServingConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ServingConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServingConfigs(EngineName, string, int?, CallSettings)

public virtual PagedEnumerable<ListServingConfigsResponse, ServingConfig> ListServingConfigs(EngineName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ServingConfigs linked to this dataStore.

Parameters
Name Description
parent EngineName

Required. Full resource name of the parent resource. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListServingConfigsResponseServingConfig

A pageable sequence of ServingConfig resources.

Example
// Create client
ServingConfigServiceClient servingConfigServiceClient = ServingConfigServiceClient.Create();
// Initialize request argument(s)
EngineName parent = EngineName.FromProjectLocationCollectionEngine("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
// Make the request
PagedEnumerable<ListServingConfigsResponse, ServingConfig> response = servingConfigServiceClient.ListServingConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ServingConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListServingConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ServingConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ServingConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ServingConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServingConfigs(ListServingConfigsRequest, CallSettings)

public virtual PagedEnumerable<ListServingConfigsResponse, ServingConfig> ListServingConfigs(ListServingConfigsRequest request, CallSettings callSettings = null)

Lists all ServingConfigs linked to this dataStore.

Parameters
Name Description
request ListServingConfigsRequest

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
PagedEnumerableListServingConfigsResponseServingConfig

A pageable sequence of ServingConfig resources.

Example
// Create client
ServingConfigServiceClient servingConfigServiceClient = ServingConfigServiceClient.Create();
// Initialize request argument(s)
ListServingConfigsRequest request = new ListServingConfigsRequest
{
    ParentAsEngineName = EngineName.FromProjectLocationCollectionEngine("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]"),
};
// Make the request
PagedEnumerable<ListServingConfigsResponse, ServingConfig> response = servingConfigServiceClient.ListServingConfigs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ServingConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListServingConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ServingConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ServingConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ServingConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServingConfigs(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListServingConfigsResponse, ServingConfig> ListServingConfigs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ServingConfigs linked to this dataStore.

Parameters
Name Description
parent string

Required. Full resource name of the parent resource. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListServingConfigsResponseServingConfig

A pageable sequence of ServingConfig resources.

Example
// Create client
ServingConfigServiceClient servingConfigServiceClient = ServingConfigServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/engines/[ENGINE]";
// Make the request
PagedEnumerable<ListServingConfigsResponse, ServingConfig> response = servingConfigServiceClient.ListServingConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ServingConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListServingConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ServingConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ServingConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ServingConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServingConfigsAsync(DataStoreName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListServingConfigsResponse, ServingConfig> ListServingConfigsAsync(DataStoreName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ServingConfigs linked to this dataStore.

Parameters
Name Description
parent DataStoreName

Required. Full resource name of the parent resource. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListServingConfigsResponseServingConfig

A pageable asynchronous sequence of ServingConfig resources.

Example
// Create client
ServingConfigServiceClient servingConfigServiceClient = await ServingConfigServiceClient.CreateAsync();
// Initialize request argument(s)
DataStoreName parent = DataStoreName.FromProjectLocationDataStore("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
// Make the request
PagedAsyncEnumerable<ListServingConfigsResponse, ServingConfig> response = servingConfigServiceClient.ListServingConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ServingConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListServingConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ServingConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ServingConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ServingConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServingConfigsAsync(EngineName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListServingConfigsResponse, ServingConfig> ListServingConfigsAsync(EngineName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ServingConfigs linked to this dataStore.

Parameters
Name Description
parent EngineName

Required. Full resource name of the parent resource. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListServingConfigsResponseServingConfig

A pageable asynchronous sequence of ServingConfig resources.

Example
// Create client
ServingConfigServiceClient servingConfigServiceClient = await ServingConfigServiceClient.CreateAsync();
// Initialize request argument(s)
EngineName parent = EngineName.FromProjectLocationCollectionEngine("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
// Make the request
PagedAsyncEnumerable<ListServingConfigsResponse, ServingConfig> response = servingConfigServiceClient.ListServingConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ServingConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListServingConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ServingConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ServingConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ServingConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServingConfigsAsync(ListServingConfigsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListServingConfigsResponse, ServingConfig> ListServingConfigsAsync(ListServingConfigsRequest request, CallSettings callSettings = null)

Lists all ServingConfigs linked to this dataStore.

Parameters
Name Description
request ListServingConfigsRequest

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
PagedAsyncEnumerableListServingConfigsResponseServingConfig

A pageable asynchronous sequence of ServingConfig resources.

Example
// Create client
ServingConfigServiceClient servingConfigServiceClient = await ServingConfigServiceClient.CreateAsync();
// Initialize request argument(s)
ListServingConfigsRequest request = new ListServingConfigsRequest
{
    ParentAsEngineName = EngineName.FromProjectLocationCollectionEngine("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]"),
};
// Make the request
PagedAsyncEnumerable<ListServingConfigsResponse, ServingConfig> response = servingConfigServiceClient.ListServingConfigsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ServingConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListServingConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ServingConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ServingConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ServingConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServingConfigsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListServingConfigsResponse, ServingConfig> ListServingConfigsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all ServingConfigs linked to this dataStore.

Parameters
Name Description
parent string

Required. Full resource name of the parent resource. Format: projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListServingConfigsResponseServingConfig

A pageable asynchronous sequence of ServingConfig resources.

Example
// Create client
ServingConfigServiceClient servingConfigServiceClient = await ServingConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/engines/[ENGINE]";
// Make the request
PagedAsyncEnumerable<ListServingConfigsResponse, ServingConfig> response = servingConfigServiceClient.ListServingConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ServingConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListServingConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ServingConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ServingConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ServingConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

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.v1beta.ServingConfig] to update. The following are NOT supported:

  • [ServingConfig.name][google.cloud.discoveryengine.v1beta.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.v1beta.ServingConfig] to update. The following are NOT supported:

  • [ServingConfig.name][google.cloud.discoveryengine.v1beta.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.v1beta.ServingConfig] to update. The following are NOT supported:

  • [ServingConfig.name][google.cloud.discoveryengine.v1beta.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);