Discovery Engine v1 API - Class CollectionServiceClientImpl (1.17.0)

1.17.0 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0-beta06

public sealed class CollectionServiceClientImpl : CollectionServiceClient

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

CollectionService client wrapper implementation, for convenient use.

Inheritance

object > CollectionServiceClient > CollectionServiceClientImpl

Inherited Members

CollectionServiceClient.DefaultEndpoint

CollectionServiceClient.DefaultScopes

CollectionServiceClient.ServiceMetadata

CollectionServiceClient.CreateAsync(CancellationToken)

CollectionServiceClient.Create()

CollectionServiceClient.ShutdownDefaultChannelsAsync()

CollectionServiceClient.DeleteCollectionAsync(DeleteCollectionRequest, CancellationToken)

CollectionServiceClient.PollOnceDeleteCollection(string, CallSettings)

CollectionServiceClient.PollOnceDeleteCollectionAsync(string, CallSettings)

CollectionServiceClient.DeleteCollection(string, CallSettings)

CollectionServiceClient.DeleteCollectionAsync(string, CallSettings)

CollectionServiceClient.DeleteCollectionAsync(string, CancellationToken)

CollectionServiceClient.DeleteCollection(CollectionName, CallSettings)

CollectionServiceClient.DeleteCollectionAsync(CollectionName, CallSettings)

CollectionServiceClient.DeleteCollectionAsync(CollectionName, CancellationToken)

CollectionServiceClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

CollectionServiceClient.GetIamPolicy(string, CallSettings)

CollectionServiceClient.GetIamPolicyAsync(string, CallSettings)

CollectionServiceClient.GetIamPolicyAsync(string, CancellationToken)

CollectionServiceClient.GetIamPolicy(IResourceName, CallSettings)

CollectionServiceClient.GetIamPolicyAsync(IResourceName, CallSettings)

CollectionServiceClient.GetIamPolicyAsync(IResourceName, CancellationToken)

CollectionServiceClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

CollectionServiceClient.SetIamPolicy(string, Policy, CallSettings)

CollectionServiceClient.SetIamPolicyAsync(string, Policy, CallSettings)

CollectionServiceClient.SetIamPolicyAsync(string, Policy, CancellationToken)

CollectionServiceClient.SetIamPolicy(IResourceName, Policy, CallSettings)

CollectionServiceClient.SetIamPolicyAsync(IResourceName, Policy, CallSettings)

CollectionServiceClient.SetIamPolicyAsync(IResourceName, Policy, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for managing [Collection][google.cloud.discoveryengine.v1.Collection]s.

Constructors

CollectionServiceClientImpl(CollectionServiceClient, CollectionServiceSettings, ILogger)

public CollectionServiceClientImpl(CollectionService.CollectionServiceClient grpcClient, CollectionServiceSettings settings, ILogger logger)

Constructs a client wrapper for the CollectionService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	CollectionServiceCollectionServiceClient The underlying gRPC client.
settings	CollectionServiceSettings The base CollectionServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

DeleteCollectionOperationsClient

public override OperationsClient DeleteCollectionOperationsClient { get; }

The long-running operations client for DeleteCollection.

Property Value
Type	Description
OperationsClient

Overrides

CollectionServiceClient.DeleteCollectionOperationsClient

GrpcClient

public override CollectionService.CollectionServiceClient GrpcClient { get; }

The underlying gRPC CollectionService client

Property Value
Type	Description
CollectionServiceCollectionServiceClient

Overrides

CollectionServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

CollectionServiceClient.LocationsClient

Methods

DeleteCollection(DeleteCollectionRequest, CallSettings)

public override Operation<Empty, DeleteCollectionMetadata> DeleteCollection(DeleteCollectionRequest request, CallSettings callSettings = null)

Deletes a [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name	Description
request	DeleteCollectionRequest 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
OperationEmptyDeleteCollectionMetadata	The RPC response.

Overrides

CollectionServiceClient.DeleteCollection(DeleteCollectionRequest, CallSettings)

DeleteCollectionAsync(DeleteCollectionRequest, CallSettings)

public override Task<Operation<Empty, DeleteCollectionMetadata>> DeleteCollectionAsync(DeleteCollectionRequest request, CallSettings callSettings = null)

Deletes a [Collection][google.cloud.discoveryengine.v1.Collection].

Parameters
Name	Description
request	DeleteCollectionRequest 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
TaskOperationEmptyDeleteCollectionMetadata	A Task containing the RPC response.

Overrides

CollectionServiceClient.DeleteCollectionAsync(DeleteCollectionRequest, CallSettings)

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM access control policy for a [Collection][google.cloud.discoveryengine.v1.Collection]. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Parameters
Name	Description
request	GetIamPolicyRequest 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
Policy	The RPC response.

Overrides

CollectionServiceClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM access control policy for a [Collection][google.cloud.discoveryengine.v1.Collection]. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Parameters
Name	Description
request	GetIamPolicyRequest 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
TaskPolicy	A Task containing the RPC response.

Overrides

CollectionServiceClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM access control policy for a [Collection][google.cloud.discoveryengine.v1.Collection]. A NOT_FOUND error is returned if the resource does not exist.

Important: When setting a policy directly on a Collection resource, the only recommended roles in the bindings are: roles/discoveryengine.admin roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer roles/discoveryengine.agentspaceViewer roles/discoveryengine.user roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a warning in logging.

Parameters
Name	Description
request	SetIamPolicyRequest 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
Policy	The RPC response.

Overrides

CollectionServiceClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM access control policy for a [Collection][google.cloud.discoveryengine.v1.Collection]. A NOT_FOUND error is returned if the resource does not exist.

Important: When setting a policy directly on a Collection resource, the only recommended roles in the bindings are: roles/discoveryengine.admin roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer roles/discoveryengine.agentspaceViewer roles/discoveryengine.user roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a warning in logging.

Parameters
Name	Description
request	SetIamPolicyRequest 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
TaskPolicy	A Task containing the RPC response.

Overrides

CollectionServiceClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)