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

public abstract class SampleQuerySetServiceClient

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

SampleQuerySetService client wrapper, for convenient use.

Inheritance

object > SampleQuerySetServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Remarks

Service for managing [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s,

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
IReadOnlyListstring
Remarks

The default SampleQuerySetService scopes are:

GrpcClient

public virtual SampleQuerySetService.SampleQuerySetServiceClient GrpcClient { get; }

The underlying gRPC SampleQuerySetService client

Property Value
Type Description
SampleQuerySetServiceSampleQuerySetServiceClient

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

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

Returns
Type Description
SampleQuerySetServiceClient

The created SampleQuerySetServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

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

The task representing the created SampleQuerySetServiceClient.

CreateSampleQuerySet(CreateSampleQuerySetRequest, CallSettings)

public virtual SampleQuerySet CreateSampleQuerySet(CreateSampleQuerySetRequest request, CallSettings callSettings = null)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
request CreateSampleQuerySetRequest

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
SampleQuerySet

The RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
CreateSampleQuerySetRequest request = new CreateSampleQuerySetRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SampleQuerySet = new SampleQuerySet(),
    SampleQuerySetId = "",
};
// Make the request
SampleQuerySet response = sampleQuerySetServiceClient.CreateSampleQuerySet(request);

CreateSampleQuerySet(LocationName, SampleQuerySet, string, CallSettings)

public virtual SampleQuerySet CreateSampleQuerySet(LocationName parent, SampleQuerySet sampleQuerySet, string sampleQuerySetId, CallSettings callSettings = null)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
parent LocationName

Required. The parent resource name, such as projects/{project}/locations/{location}.
sampleQuerySet SampleQuerySet

Required. The [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to create.
sampleQuerySetId string

Required. The ID to use for the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], which will become the final component of the [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name].

If the caller does not have permission to create the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s with the same [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
callSettings CallSettings

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

The RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SampleQuerySet sampleQuerySet = new SampleQuerySet();
string sampleQuerySetId = "";
// Make the request
SampleQuerySet response = sampleQuerySetServiceClient.CreateSampleQuerySet(parent, sampleQuerySet, sampleQuerySetId);

CreateSampleQuerySet(string, SampleQuerySet, string, CallSettings)

public virtual SampleQuerySet CreateSampleQuerySet(string parent, SampleQuerySet sampleQuerySet, string sampleQuerySetId, CallSettings callSettings = null)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
parent string

Required. The parent resource name, such as projects/{project}/locations/{location}.
sampleQuerySet SampleQuerySet

Required. The [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to create.
sampleQuerySetId string

Required. The ID to use for the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], which will become the final component of the [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name].

If the caller does not have permission to create the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s with the same [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
callSettings CallSettings

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

The RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SampleQuerySet sampleQuerySet = new SampleQuerySet();
string sampleQuerySetId = "";
// Make the request
SampleQuerySet response = sampleQuerySetServiceClient.CreateSampleQuerySet(parent, sampleQuerySet, sampleQuerySetId);

CreateSampleQuerySetAsync(CreateSampleQuerySetRequest, CallSettings)

public virtual Task<SampleQuerySet> CreateSampleQuerySetAsync(CreateSampleQuerySetRequest request, CallSettings callSettings = null)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
request CreateSampleQuerySetRequest

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
TaskSampleQuerySet

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
CreateSampleQuerySetRequest request = new CreateSampleQuerySetRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SampleQuerySet = new SampleQuerySet(),
    SampleQuerySetId = "",
};
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.CreateSampleQuerySetAsync(request);

CreateSampleQuerySetAsync(CreateSampleQuerySetRequest, CancellationToken)

public virtual Task<SampleQuerySet> CreateSampleQuerySetAsync(CreateSampleQuerySetRequest request, CancellationToken cancellationToken)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
request CreateSampleQuerySetRequest

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

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
CreateSampleQuerySetRequest request = new CreateSampleQuerySetRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SampleQuerySet = new SampleQuerySet(),
    SampleQuerySetId = "",
};
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.CreateSampleQuerySetAsync(request);

CreateSampleQuerySetAsync(LocationName, SampleQuerySet, string, CallSettings)

public virtual Task<SampleQuerySet> CreateSampleQuerySetAsync(LocationName parent, SampleQuerySet sampleQuerySet, string sampleQuerySetId, CallSettings callSettings = null)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
parent LocationName

Required. The parent resource name, such as projects/{project}/locations/{location}.
sampleQuerySet SampleQuerySet

Required. The [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to create.
sampleQuerySetId string

Required. The ID to use for the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], which will become the final component of the [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name].

If the caller does not have permission to create the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s with the same [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
callSettings CallSettings

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SampleQuerySet sampleQuerySet = new SampleQuerySet();
string sampleQuerySetId = "";
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.CreateSampleQuerySetAsync(parent, sampleQuerySet, sampleQuerySetId);

CreateSampleQuerySetAsync(LocationName, SampleQuerySet, string, CancellationToken)

public virtual Task<SampleQuerySet> CreateSampleQuerySetAsync(LocationName parent, SampleQuerySet sampleQuerySet, string sampleQuerySetId, CancellationToken cancellationToken)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
parent LocationName

Required. The parent resource name, such as projects/{project}/locations/{location}.
sampleQuerySet SampleQuerySet

Required. The [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to create.
sampleQuerySetId string

Required. The ID to use for the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], which will become the final component of the [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name].

If the caller does not have permission to create the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s with the same [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
cancellationToken CancellationToken

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SampleQuerySet sampleQuerySet = new SampleQuerySet();
string sampleQuerySetId = "";
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.CreateSampleQuerySetAsync(parent, sampleQuerySet, sampleQuerySetId);

CreateSampleQuerySetAsync(string, SampleQuerySet, string, CallSettings)

public virtual Task<SampleQuerySet> CreateSampleQuerySetAsync(string parent, SampleQuerySet sampleQuerySet, string sampleQuerySetId, CallSettings callSettings = null)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
parent string

Required. The parent resource name, such as projects/{project}/locations/{location}.
sampleQuerySet SampleQuerySet

Required. The [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to create.
sampleQuerySetId string

Required. The ID to use for the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], which will become the final component of the [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name].

If the caller does not have permission to create the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s with the same [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
callSettings CallSettings

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SampleQuerySet sampleQuerySet = new SampleQuerySet();
string sampleQuerySetId = "";
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.CreateSampleQuerySetAsync(parent, sampleQuerySet, sampleQuerySetId);

CreateSampleQuerySetAsync(string, SampleQuerySet, string, CancellationToken)

public virtual Task<SampleQuerySet> CreateSampleQuerySetAsync(string parent, SampleQuerySet sampleQuerySet, string sampleQuerySetId, CancellationToken cancellationToken)

Creates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]

Parameters
Name Description
parent string

Required. The parent resource name, such as projects/{project}/locations/{location}.
sampleQuerySet SampleQuerySet

Required. The [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to create.
sampleQuerySetId string

Required. The ID to use for the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], which will become the final component of the [SampleQuerySet.name][google.cloud.discoveryengine.v1beta.SampleQuerySet.name].

If the caller does not have permission to create the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s with the same [parent][google.cloud.discoveryengine.v1beta.CreateSampleQuerySetRequest.parent]. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
cancellationToken CancellationToken

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SampleQuerySet sampleQuerySet = new SampleQuerySet();
string sampleQuerySetId = "";
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.CreateSampleQuerySetAsync(parent, sampleQuerySet, sampleQuerySetId);

DeleteSampleQuerySet(DeleteSampleQuerySetRequest, CallSettings)

public virtual void DeleteSampleQuerySet(DeleteSampleQuerySetRequest request, CallSettings callSettings = null)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request DeleteSampleQuerySetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
DeleteSampleQuerySetRequest request = new DeleteSampleQuerySetRequest
{
    SampleQuerySetName = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]"),
};
// Make the request
sampleQuerySetServiceClient.DeleteSampleQuerySet(request);

DeleteSampleQuerySet(SampleQuerySetName, CallSettings)

public virtual void DeleteSampleQuerySet(SampleQuerySetName name, CallSettings callSettings = null)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name SampleQuerySetName

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to delete the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to delete does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
SampleQuerySetName name = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]");
// Make the request
sampleQuerySetServiceClient.DeleteSampleQuerySet(name);

DeleteSampleQuerySet(string, CallSettings)

public virtual void DeleteSampleQuerySet(string name, CallSettings callSettings = null)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name string

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to delete the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to delete does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sampleQuerySets/[SAMPLE_QUERY_SET]";
// Make the request
sampleQuerySetServiceClient.DeleteSampleQuerySet(name);

DeleteSampleQuerySetAsync(DeleteSampleQuerySetRequest, CallSettings)

public virtual Task DeleteSampleQuerySetAsync(DeleteSampleQuerySetRequest request, CallSettings callSettings = null)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request DeleteSampleQuerySetRequest

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
Task

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteSampleQuerySetRequest request = new DeleteSampleQuerySetRequest
{
    SampleQuerySetName = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]"),
};
// Make the request
await sampleQuerySetServiceClient.DeleteSampleQuerySetAsync(request);

DeleteSampleQuerySetAsync(DeleteSampleQuerySetRequest, CancellationToken)

public virtual Task DeleteSampleQuerySetAsync(DeleteSampleQuerySetRequest request, CancellationToken cancellationToken)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request DeleteSampleQuerySetRequest

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

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteSampleQuerySetRequest request = new DeleteSampleQuerySetRequest
{
    SampleQuerySetName = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]"),
};
// Make the request
await sampleQuerySetServiceClient.DeleteSampleQuerySetAsync(request);

DeleteSampleQuerySetAsync(SampleQuerySetName, CallSettings)

public virtual Task DeleteSampleQuerySetAsync(SampleQuerySetName name, CallSettings callSettings = null)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name SampleQuerySetName

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to delete the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to delete does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
SampleQuerySetName name = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]");
// Make the request
await sampleQuerySetServiceClient.DeleteSampleQuerySetAsync(name);

DeleteSampleQuerySetAsync(SampleQuerySetName, CancellationToken)

public virtual Task DeleteSampleQuerySetAsync(SampleQuerySetName name, CancellationToken cancellationToken)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name SampleQuerySetName

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to delete the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to delete does not exist, a NOT_FOUND error is returned.
cancellationToken CancellationToken

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
SampleQuerySetName name = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]");
// Make the request
await sampleQuerySetServiceClient.DeleteSampleQuerySetAsync(name);

DeleteSampleQuerySetAsync(string, CallSettings)

public virtual Task DeleteSampleQuerySetAsync(string name, CallSettings callSettings = null)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name string

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to delete the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to delete does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sampleQuerySets/[SAMPLE_QUERY_SET]";
// Make the request
await sampleQuerySetServiceClient.DeleteSampleQuerySetAsync(name);

DeleteSampleQuerySetAsync(string, CancellationToken)

public virtual Task DeleteSampleQuerySetAsync(string name, CancellationToken cancellationToken)

Deletes a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name string

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to delete the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to delete does not exist, a NOT_FOUND error is returned.
cancellationToken CancellationToken

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sampleQuerySets/[SAMPLE_QUERY_SET]";
// Make the request
await sampleQuerySetServiceClient.DeleteSampleQuerySetAsync(name);

GetSampleQuerySet(GetSampleQuerySetRequest, CallSettings)

public virtual SampleQuerySet GetSampleQuerySet(GetSampleQuerySetRequest request, CallSettings callSettings = null)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request GetSampleQuerySetRequest

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
SampleQuerySet

The RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
GetSampleQuerySetRequest request = new GetSampleQuerySetRequest
{
    SampleQuerySetName = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]"),
};
// Make the request
SampleQuerySet response = sampleQuerySetServiceClient.GetSampleQuerySet(request);

GetSampleQuerySet(SampleQuerySetName, CallSettings)

public virtual SampleQuerySet GetSampleQuerySet(SampleQuerySetName name, CallSettings callSettings = null)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name SampleQuerySetName

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to access the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

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

The RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
SampleQuerySetName name = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]");
// Make the request
SampleQuerySet response = sampleQuerySetServiceClient.GetSampleQuerySet(name);

GetSampleQuerySet(string, CallSettings)

public virtual SampleQuerySet GetSampleQuerySet(string name, CallSettings callSettings = null)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name string

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to access the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

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

The RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sampleQuerySets/[SAMPLE_QUERY_SET]";
// Make the request
SampleQuerySet response = sampleQuerySetServiceClient.GetSampleQuerySet(name);

GetSampleQuerySetAsync(GetSampleQuerySetRequest, CallSettings)

public virtual Task<SampleQuerySet> GetSampleQuerySetAsync(GetSampleQuerySetRequest request, CallSettings callSettings = null)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request GetSampleQuerySetRequest

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
TaskSampleQuerySet

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
GetSampleQuerySetRequest request = new GetSampleQuerySetRequest
{
    SampleQuerySetName = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]"),
};
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.GetSampleQuerySetAsync(request);

GetSampleQuerySetAsync(GetSampleQuerySetRequest, CancellationToken)

public virtual Task<SampleQuerySet> GetSampleQuerySetAsync(GetSampleQuerySetRequest request, CancellationToken cancellationToken)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request GetSampleQuerySetRequest

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

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
GetSampleQuerySetRequest request = new GetSampleQuerySetRequest
{
    SampleQuerySetName = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]"),
};
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.GetSampleQuerySetAsync(request);

GetSampleQuerySetAsync(SampleQuerySetName, CallSettings)

public virtual Task<SampleQuerySet> GetSampleQuerySetAsync(SampleQuerySetName name, CallSettings callSettings = null)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name SampleQuerySetName

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to access the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
SampleQuerySetName name = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]");
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.GetSampleQuerySetAsync(name);

GetSampleQuerySetAsync(SampleQuerySetName, CancellationToken)

public virtual Task<SampleQuerySet> GetSampleQuerySetAsync(SampleQuerySetName name, CancellationToken cancellationToken)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name SampleQuerySetName

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to access the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] does not exist, a NOT_FOUND error is returned.
cancellationToken CancellationToken

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
SampleQuerySetName name = SampleQuerySetName.FromProjectLocationSampleQuerySet("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]");
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.GetSampleQuerySetAsync(name);

GetSampleQuerySetAsync(string, CallSettings)

public virtual Task<SampleQuerySet> GetSampleQuerySetAsync(string name, CallSettings callSettings = null)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name string

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to access the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] does not exist, a NOT_FOUND error is returned.
callSettings CallSettings

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sampleQuerySets/[SAMPLE_QUERY_SET]";
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.GetSampleQuerySetAsync(name);

GetSampleQuerySetAsync(string, CancellationToken)

public virtual Task<SampleQuerySet> GetSampleQuerySetAsync(string name, CancellationToken cancellationToken)

Gets a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
name string

Required. Full resource name of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}.

If the caller does not have permission to access the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] does not exist, a NOT_FOUND error is returned.
cancellationToken CancellationToken

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/sampleQuerySets/[SAMPLE_QUERY_SET]";
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.GetSampleQuerySetAsync(name);

ListSampleQuerySets(ListSampleQuerySetsRequest, CallSettings)

public virtual PagedEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> ListSampleQuerySets(ListSampleQuerySetsRequest request, CallSettings callSettings = null)

Gets a list of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.

Parameters
Name Description
request ListSampleQuerySetsRequest

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
PagedEnumerableListSampleQuerySetsResponseSampleQuerySet

A pageable sequence of SampleQuerySet resources.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
ListSampleQuerySetsRequest request = new ListSampleQuerySetsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> response = sampleQuerySetServiceClient.ListSampleQuerySets(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (SampleQuerySet 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 (ListSampleQuerySetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SampleQuerySet 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<SampleQuerySet> 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 (SampleQuerySet 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;

ListSampleQuerySets(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> ListSampleQuerySets(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Gets a list of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.

Parameters
Name Description
parent LocationName

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
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
PagedEnumerableListSampleQuerySetsResponseSampleQuerySet

A pageable sequence of SampleQuerySet resources.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> response = sampleQuerySetServiceClient.ListSampleQuerySets(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SampleQuerySet 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 (ListSampleQuerySetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SampleQuerySet 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<SampleQuerySet> 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 (SampleQuerySet 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;

ListSampleQuerySets(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> ListSampleQuerySets(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Gets a list of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.

Parameters
Name Description
parent string

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
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
PagedEnumerableListSampleQuerySetsResponseSampleQuerySet

A pageable sequence of SampleQuerySet resources.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> response = sampleQuerySetServiceClient.ListSampleQuerySets(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SampleQuerySet 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 (ListSampleQuerySetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SampleQuerySet 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<SampleQuerySet> 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 (SampleQuerySet 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;

ListSampleQuerySetsAsync(ListSampleQuerySetsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> ListSampleQuerySetsAsync(ListSampleQuerySetsRequest request, CallSettings callSettings = null)

Gets a list of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.

Parameters
Name Description
request ListSampleQuerySetsRequest

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
PagedAsyncEnumerableListSampleQuerySetsResponseSampleQuerySet

A pageable asynchronous sequence of SampleQuerySet resources.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
ListSampleQuerySetsRequest request = new ListSampleQuerySetsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> response = sampleQuerySetServiceClient.ListSampleQuerySetsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SampleQuerySet 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((ListSampleQuerySetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SampleQuerySet 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<SampleQuerySet> 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 (SampleQuerySet 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;

ListSampleQuerySetsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> ListSampleQuerySetsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Gets a list of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.

Parameters
Name Description
parent LocationName

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
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
PagedAsyncEnumerableListSampleQuerySetsResponseSampleQuerySet

A pageable asynchronous sequence of SampleQuerySet resources.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> response = sampleQuerySetServiceClient.ListSampleQuerySetsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SampleQuerySet 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((ListSampleQuerySetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SampleQuerySet 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<SampleQuerySet> 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 (SampleQuerySet 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;

ListSampleQuerySetsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> ListSampleQuerySetsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Gets a list of [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s.

Parameters
Name Description
parent string

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
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
PagedAsyncEnumerableListSampleQuerySetsResponseSampleQuerySet

A pageable asynchronous sequence of SampleQuerySet resources.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListSampleQuerySetsResponse, SampleQuerySet> response = sampleQuerySetServiceClient.ListSampleQuerySetsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SampleQuerySet 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((ListSampleQuerySetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SampleQuerySet 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<SampleQuerySet> 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 (SampleQuerySet 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.

UpdateSampleQuerySet(SampleQuerySet, FieldMask, CallSettings)

public virtual SampleQuerySet UpdateSampleQuerySet(SampleQuerySet sampleQuerySet, FieldMask updateMask, CallSettings callSettings = null)

Updates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
sampleQuerySet SampleQuerySet

Required. The sample query set to update.

If the caller does not have permission to update the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to update does not exist a NOT_FOUND error is returned.
updateMask FieldMask

Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
callSettings CallSettings

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

The RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
SampleQuerySet sampleQuerySet = new SampleQuerySet();
FieldMask updateMask = new FieldMask();
// Make the request
SampleQuerySet response = sampleQuerySetServiceClient.UpdateSampleQuerySet(sampleQuerySet, updateMask);

UpdateSampleQuerySet(UpdateSampleQuerySetRequest, CallSettings)

public virtual SampleQuerySet UpdateSampleQuerySet(UpdateSampleQuerySetRequest request, CallSettings callSettings = null)

Updates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request UpdateSampleQuerySetRequest

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
SampleQuerySet

The RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = SampleQuerySetServiceClient.Create();
// Initialize request argument(s)
UpdateSampleQuerySetRequest request = new UpdateSampleQuerySetRequest
{
    SampleQuerySet = new SampleQuerySet(),
    UpdateMask = new FieldMask(),
};
// Make the request
SampleQuerySet response = sampleQuerySetServiceClient.UpdateSampleQuerySet(request);

UpdateSampleQuerySetAsync(SampleQuerySet, FieldMask, CallSettings)

public virtual Task<SampleQuerySet> UpdateSampleQuerySetAsync(SampleQuerySet sampleQuerySet, FieldMask updateMask, CallSettings callSettings = null)

Updates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
sampleQuerySet SampleQuerySet

Required. The sample query set to update.

If the caller does not have permission to update the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to update does not exist a NOT_FOUND error is returned.
updateMask FieldMask

Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
callSettings CallSettings

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
SampleQuerySet sampleQuerySet = new SampleQuerySet();
FieldMask updateMask = new FieldMask();
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.UpdateSampleQuerySetAsync(sampleQuerySet, updateMask);

UpdateSampleQuerySetAsync(SampleQuerySet, FieldMask, CancellationToken)

public virtual Task<SampleQuerySet> UpdateSampleQuerySetAsync(SampleQuerySet sampleQuerySet, FieldMask updateMask, CancellationToken cancellationToken)

Updates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
sampleQuerySet SampleQuerySet

Required. The sample query set to update.

If the caller does not have permission to update the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet] to update does not exist a NOT_FOUND error is returned.
updateMask FieldMask

Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
cancellationToken CancellationToken

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
SampleQuerySet sampleQuerySet = new SampleQuerySet();
FieldMask updateMask = new FieldMask();
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.UpdateSampleQuerySetAsync(sampleQuerySet, updateMask);

UpdateSampleQuerySetAsync(UpdateSampleQuerySetRequest, CallSettings)

public virtual Task<SampleQuerySet> UpdateSampleQuerySetAsync(UpdateSampleQuerySetRequest request, CallSettings callSettings = null)

Updates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request UpdateSampleQuerySetRequest

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
TaskSampleQuerySet

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateSampleQuerySetRequest request = new UpdateSampleQuerySetRequest
{
    SampleQuerySet = new SampleQuerySet(),
    UpdateMask = new FieldMask(),
};
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.UpdateSampleQuerySetAsync(request);

UpdateSampleQuerySetAsync(UpdateSampleQuerySetRequest, CancellationToken)

public virtual Task<SampleQuerySet> UpdateSampleQuerySetAsync(UpdateSampleQuerySetRequest request, CancellationToken cancellationToken)

Updates a [SampleQuerySet][google.cloud.discoveryengine.v1beta.SampleQuerySet].

Parameters
Name Description
request UpdateSampleQuerySetRequest

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

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

A Task containing the RPC response.
Example 
// Create client
SampleQuerySetServiceClient sampleQuerySetServiceClient = await SampleQuerySetServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateSampleQuerySetRequest request = new UpdateSampleQuerySetRequest
{
    SampleQuerySet = new SampleQuerySet(),
    UpdateMask = new FieldMask(),
};
// Make the request
SampleQuerySet response = await sampleQuerySetServiceClient.UpdateSampleQuerySetAsync(request);