Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.CollectionsResource

The "collections" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.CollectionsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DiscoveryEngine.v1
Assembly: Google.Apis.DiscoveryEngine.v1.dll
Syntax
public class ProjectsResource.LocationsResource.CollectionsResource

Constructors

CollectionsResource(IClientService)

Constructs a new resource.

Declaration
public CollectionsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

DataConnector

Gets the DataConnector resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.DataConnectorResource DataConnector { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.DataConnectorResource

DataStores

Gets the DataStores resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource DataStores { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.DataStoresResource

Engines

Gets the Engines resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource Engines { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource

Operations

Gets the Operations resource.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.OperationsResource Operations { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.CollectionsResource.OperationsResource

Methods

Delete(string)

Deletes a Collection.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The full resource name of the Collection, in the format of projects/{project}/locations/{location}/collections/{collection}.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.DeleteRequest

GetDataConnector(string)

Gets the DataConnector. DataConnector is a singleton resource for each Collection.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.GetDataConnectorRequest GetDataConnector(string name)
Parameters
Type Name Description
string name

Required. Full resource name of DataConnector, such as projects/{project}/locations/{location}/collections/{collection_id}/dataConnector. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.GetDataConnectorRequest

GetIamPolicy(string)

Gets the IAM access control policy for a 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.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.GetIamPolicyRequest

SetIamPolicy(GoogleIamV1SetIamPolicyRequest, string)

Sets the IAM access control policy for a 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.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.SetIamPolicyRequest SetIamPolicy(GoogleIamV1SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GoogleIamV1SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.SetIamPolicyRequest

UpdateDataConnector(GoogleCloudDiscoveryengineV1DataConnector, string)

Updates a DataConnector.

Declaration
public virtual ProjectsResource.LocationsResource.CollectionsResource.UpdateDataConnectorRequest UpdateDataConnector(GoogleCloudDiscoveryengineV1DataConnector body, string name)
Parameters
Type Name Description
GoogleCloudDiscoveryengineV1DataConnector body

The body of the request.

string name

Identifier. The full resource name of the Data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

Returns
Type Description
ProjectsResource.LocationsResource.CollectionsResource.UpdateDataConnectorRequest
In this article
Back to top Generated by DocFX