Vector Search v1 API - Class DataObjectServiceClient (1.0.0-beta01)

public abstract class DataObjectServiceClient

Reference documentation and code samples for the Vector Search v1 API class DataObjectServiceClient.

DataObjectService client wrapper, for convenient use.

Inheritance

object > DataObjectServiceClient

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Remarks

Service for creating and managing data objects.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the DataObjectService service, which is a host of "vectorsearch.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DataObjectService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default DataObjectService scopes are:

GrpcClient

public virtual DataObjectService.DataObjectServiceClient GrpcClient { get; }

The underlying gRPC DataObjectService client

Property Value
Type Description
DataObjectServiceDataObjectServiceClient

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

BatchCreateDataObjects(BatchCreateDataObjectsRequest, CallSettings)

public virtual BatchCreateDataObjectsResponse BatchCreateDataObjects(BatchCreateDataObjectsRequest request, CallSettings callSettings = null)

Creates a batch of dataObjects.

Parameters
Name Description
request BatchCreateDataObjectsRequest

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
BatchCreateDataObjectsResponse

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
BatchCreateDataObjectsRequest request = new BatchCreateDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new CreateDataObjectRequest(),
    },
};
// Make the request
BatchCreateDataObjectsResponse response = dataObjectServiceClient.BatchCreateDataObjects(request);

BatchCreateDataObjectsAsync(BatchCreateDataObjectsRequest, CallSettings)

public virtual Task<BatchCreateDataObjectsResponse> BatchCreateDataObjectsAsync(BatchCreateDataObjectsRequest request, CallSettings callSettings = null)

Creates a batch of dataObjects.

Parameters
Name Description
request BatchCreateDataObjectsRequest

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
TaskBatchCreateDataObjectsResponse

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateDataObjectsRequest request = new BatchCreateDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new CreateDataObjectRequest(),
    },
};
// Make the request
BatchCreateDataObjectsResponse response = await dataObjectServiceClient.BatchCreateDataObjectsAsync(request);

BatchCreateDataObjectsAsync(BatchCreateDataObjectsRequest, CancellationToken)

public virtual Task<BatchCreateDataObjectsResponse> BatchCreateDataObjectsAsync(BatchCreateDataObjectsRequest request, CancellationToken cancellationToken)

Creates a batch of dataObjects.

Parameters
Name Description
request BatchCreateDataObjectsRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBatchCreateDataObjectsResponse

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
BatchCreateDataObjectsRequest request = new BatchCreateDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new CreateDataObjectRequest(),
    },
};
// Make the request
BatchCreateDataObjectsResponse response = await dataObjectServiceClient.BatchCreateDataObjectsAsync(request);

BatchDeleteDataObjects(BatchDeleteDataObjectsRequest, CallSettings)

public virtual void BatchDeleteDataObjects(BatchDeleteDataObjectsRequest request, CallSettings callSettings = null)

Deletes dataObjects in a batch.

Parameters
Name Description
request BatchDeleteDataObjectsRequest

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
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
BatchDeleteDataObjectsRequest request = new BatchDeleteDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new DeleteDataObjectRequest(),
    },
};
// Make the request
dataObjectServiceClient.BatchDeleteDataObjects(request);

BatchDeleteDataObjects(CollectionName, IEnumerable<DeleteDataObjectRequest>, CallSettings)

public virtual void BatchDeleteDataObjects(CollectionName parent, IEnumerable<DeleteDataObjectRequest> requests, CallSettings callSettings = null)

Deletes dataObjects in a batch.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to delete the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}.

requests IEnumerableDeleteDataObjectRequest

Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
IEnumerable<DeleteDataObjectRequest> requests = new DeleteDataObjectRequest[]
{
    new DeleteDataObjectRequest(),
};
// Make the request
dataObjectServiceClient.BatchDeleteDataObjects(parent, requests);

BatchDeleteDataObjects(string, IEnumerable<DeleteDataObjectRequest>, CallSettings)

public virtual void BatchDeleteDataObjects(string parent, IEnumerable<DeleteDataObjectRequest> requests, CallSettings callSettings = null)

Deletes dataObjects in a batch.

Parameters
Name Description
parent string

Required. The resource name of the Collection to delete the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}.

requests IEnumerableDeleteDataObjectRequest

Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
IEnumerable<DeleteDataObjectRequest> requests = new DeleteDataObjectRequest[]
{
    new DeleteDataObjectRequest(),
};
// Make the request
dataObjectServiceClient.BatchDeleteDataObjects(parent, requests);

BatchDeleteDataObjectsAsync(BatchDeleteDataObjectsRequest, CallSettings)

public virtual Task BatchDeleteDataObjectsAsync(BatchDeleteDataObjectsRequest request, CallSettings callSettings = null)

Deletes dataObjects in a batch.

Parameters
Name Description
request BatchDeleteDataObjectsRequest

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
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
BatchDeleteDataObjectsRequest request = new BatchDeleteDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new DeleteDataObjectRequest(),
    },
};
// Make the request
await dataObjectServiceClient.BatchDeleteDataObjectsAsync(request);

BatchDeleteDataObjectsAsync(BatchDeleteDataObjectsRequest, CancellationToken)

public virtual Task BatchDeleteDataObjectsAsync(BatchDeleteDataObjectsRequest request, CancellationToken cancellationToken)

Deletes dataObjects in a batch.

Parameters
Name Description
request BatchDeleteDataObjectsRequest

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
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
BatchDeleteDataObjectsRequest request = new BatchDeleteDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new DeleteDataObjectRequest(),
    },
};
// Make the request
await dataObjectServiceClient.BatchDeleteDataObjectsAsync(request);

BatchDeleteDataObjectsAsync(CollectionName, IEnumerable<DeleteDataObjectRequest>, CallSettings)

public virtual Task BatchDeleteDataObjectsAsync(CollectionName parent, IEnumerable<DeleteDataObjectRequest> requests, CallSettings callSettings = null)

Deletes dataObjects in a batch.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to delete the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}.

requests IEnumerableDeleteDataObjectRequest

Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
IEnumerable<DeleteDataObjectRequest> requests = new DeleteDataObjectRequest[]
{
    new DeleteDataObjectRequest(),
};
// Make the request
await dataObjectServiceClient.BatchDeleteDataObjectsAsync(parent, requests);

BatchDeleteDataObjectsAsync(CollectionName, IEnumerable<DeleteDataObjectRequest>, CancellationToken)

public virtual Task BatchDeleteDataObjectsAsync(CollectionName parent, IEnumerable<DeleteDataObjectRequest> requests, CancellationToken cancellationToken)

Deletes dataObjects in a batch.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to delete the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}.

requests IEnumerableDeleteDataObjectRequest

Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
IEnumerable<DeleteDataObjectRequest> requests = new DeleteDataObjectRequest[]
{
    new DeleteDataObjectRequest(),
};
// Make the request
await dataObjectServiceClient.BatchDeleteDataObjectsAsync(parent, requests);

BatchDeleteDataObjectsAsync(string, IEnumerable<DeleteDataObjectRequest>, CallSettings)

public virtual Task BatchDeleteDataObjectsAsync(string parent, IEnumerable<DeleteDataObjectRequest> requests, CallSettings callSettings = null)

Deletes dataObjects in a batch.

Parameters
Name Description
parent string

Required. The resource name of the Collection to delete the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}.

requests IEnumerableDeleteDataObjectRequest

Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
IEnumerable<DeleteDataObjectRequest> requests = new DeleteDataObjectRequest[]
{
    new DeleteDataObjectRequest(),
};
// Make the request
await dataObjectServiceClient.BatchDeleteDataObjectsAsync(parent, requests);

BatchDeleteDataObjectsAsync(string, IEnumerable<DeleteDataObjectRequest>, CancellationToken)

public virtual Task BatchDeleteDataObjectsAsync(string parent, IEnumerable<DeleteDataObjectRequest> requests, CancellationToken cancellationToken)

Deletes dataObjects in a batch.

Parameters
Name Description
parent string

Required. The resource name of the Collection to delete the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}.

requests IEnumerableDeleteDataObjectRequest

Required. The request message specifying the resources to delete. A maximum of 1000 DataObjects can be deleted in a batch.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
IEnumerable<DeleteDataObjectRequest> requests = new DeleteDataObjectRequest[]
{
    new DeleteDataObjectRequest(),
};
// Make the request
await dataObjectServiceClient.BatchDeleteDataObjectsAsync(parent, requests);

BatchUpdateDataObjects(BatchUpdateDataObjectsRequest, CallSettings)

public virtual BatchUpdateDataObjectsResponse BatchUpdateDataObjects(BatchUpdateDataObjectsRequest request, CallSettings callSettings = null)

Updates dataObjects in a batch.

Parameters
Name Description
request BatchUpdateDataObjectsRequest

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
BatchUpdateDataObjectsResponse

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
BatchUpdateDataObjectsRequest request = new BatchUpdateDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new UpdateDataObjectRequest(),
    },
};
// Make the request
BatchUpdateDataObjectsResponse response = dataObjectServiceClient.BatchUpdateDataObjects(request);

BatchUpdateDataObjects(CollectionName, IEnumerable<UpdateDataObjectRequest>, CallSettings)

public virtual BatchUpdateDataObjectsResponse BatchUpdateDataObjects(CollectionName parent, IEnumerable<UpdateDataObjectRequest> requests, CallSettings callSettings = null)

Updates dataObjects in a batch.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to update the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}. The parent field in the UpdateDataObjectRequest messages must match this field.

requests IEnumerableUpdateDataObjectRequest

Required. The request message specifying the resources to update. A maximum of 1000 DataObjects can be updated in a batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchUpdateDataObjectsResponse

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
IEnumerable<UpdateDataObjectRequest> requests = new UpdateDataObjectRequest[]
{
    new UpdateDataObjectRequest(),
};
// Make the request
BatchUpdateDataObjectsResponse response = dataObjectServiceClient.BatchUpdateDataObjects(parent, requests);

BatchUpdateDataObjects(string, IEnumerable<UpdateDataObjectRequest>, CallSettings)

public virtual BatchUpdateDataObjectsResponse BatchUpdateDataObjects(string parent, IEnumerable<UpdateDataObjectRequest> requests, CallSettings callSettings = null)

Updates dataObjects in a batch.

Parameters
Name Description
parent string

Required. The resource name of the Collection to update the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}. The parent field in the UpdateDataObjectRequest messages must match this field.

requests IEnumerableUpdateDataObjectRequest

Required. The request message specifying the resources to update. A maximum of 1000 DataObjects can be updated in a batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BatchUpdateDataObjectsResponse

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
IEnumerable<UpdateDataObjectRequest> requests = new UpdateDataObjectRequest[]
{
    new UpdateDataObjectRequest(),
};
// Make the request
BatchUpdateDataObjectsResponse response = dataObjectServiceClient.BatchUpdateDataObjects(parent, requests);

BatchUpdateDataObjectsAsync(BatchUpdateDataObjectsRequest, CallSettings)

public virtual Task<BatchUpdateDataObjectsResponse> BatchUpdateDataObjectsAsync(BatchUpdateDataObjectsRequest request, CallSettings callSettings = null)

Updates dataObjects in a batch.

Parameters
Name Description
request BatchUpdateDataObjectsRequest

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
TaskBatchUpdateDataObjectsResponse

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateDataObjectsRequest request = new BatchUpdateDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new UpdateDataObjectRequest(),
    },
};
// Make the request
BatchUpdateDataObjectsResponse response = await dataObjectServiceClient.BatchUpdateDataObjectsAsync(request);

BatchUpdateDataObjectsAsync(BatchUpdateDataObjectsRequest, CancellationToken)

public virtual Task<BatchUpdateDataObjectsResponse> BatchUpdateDataObjectsAsync(BatchUpdateDataObjectsRequest request, CancellationToken cancellationToken)

Updates dataObjects in a batch.

Parameters
Name Description
request BatchUpdateDataObjectsRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBatchUpdateDataObjectsResponse

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateDataObjectsRequest request = new BatchUpdateDataObjectsRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    Requests =
    {
        new UpdateDataObjectRequest(),
    },
};
// Make the request
BatchUpdateDataObjectsResponse response = await dataObjectServiceClient.BatchUpdateDataObjectsAsync(request);

BatchUpdateDataObjectsAsync(CollectionName, IEnumerable<UpdateDataObjectRequest>, CallSettings)

public virtual Task<BatchUpdateDataObjectsResponse> BatchUpdateDataObjectsAsync(CollectionName parent, IEnumerable<UpdateDataObjectRequest> requests, CallSettings callSettings = null)

Updates dataObjects in a batch.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to update the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}. The parent field in the UpdateDataObjectRequest messages must match this field.

requests IEnumerableUpdateDataObjectRequest

Required. The request message specifying the resources to update. A maximum of 1000 DataObjects can be updated in a batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBatchUpdateDataObjectsResponse

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
IEnumerable<UpdateDataObjectRequest> requests = new UpdateDataObjectRequest[]
{
    new UpdateDataObjectRequest(),
};
// Make the request
BatchUpdateDataObjectsResponse response = await dataObjectServiceClient.BatchUpdateDataObjectsAsync(parent, requests);

BatchUpdateDataObjectsAsync(CollectionName, IEnumerable<UpdateDataObjectRequest>, CancellationToken)

public virtual Task<BatchUpdateDataObjectsResponse> BatchUpdateDataObjectsAsync(CollectionName parent, IEnumerable<UpdateDataObjectRequest> requests, CancellationToken cancellationToken)

Updates dataObjects in a batch.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to update the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}. The parent field in the UpdateDataObjectRequest messages must match this field.

requests IEnumerableUpdateDataObjectRequest

Required. The request message specifying the resources to update. A maximum of 1000 DataObjects can be updated in a batch.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBatchUpdateDataObjectsResponse

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
IEnumerable<UpdateDataObjectRequest> requests = new UpdateDataObjectRequest[]
{
    new UpdateDataObjectRequest(),
};
// Make the request
BatchUpdateDataObjectsResponse response = await dataObjectServiceClient.BatchUpdateDataObjectsAsync(parent, requests);

BatchUpdateDataObjectsAsync(string, IEnumerable<UpdateDataObjectRequest>, CallSettings)

public virtual Task<BatchUpdateDataObjectsResponse> BatchUpdateDataObjectsAsync(string parent, IEnumerable<UpdateDataObjectRequest> requests, CallSettings callSettings = null)

Updates dataObjects in a batch.

Parameters
Name Description
parent string

Required. The resource name of the Collection to update the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}. The parent field in the UpdateDataObjectRequest messages must match this field.

requests IEnumerableUpdateDataObjectRequest

Required. The request message specifying the resources to update. A maximum of 1000 DataObjects can be updated in a batch.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBatchUpdateDataObjectsResponse

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
IEnumerable<UpdateDataObjectRequest> requests = new UpdateDataObjectRequest[]
{
    new UpdateDataObjectRequest(),
};
// Make the request
BatchUpdateDataObjectsResponse response = await dataObjectServiceClient.BatchUpdateDataObjectsAsync(parent, requests);

BatchUpdateDataObjectsAsync(string, IEnumerable<UpdateDataObjectRequest>, CancellationToken)

public virtual Task<BatchUpdateDataObjectsResponse> BatchUpdateDataObjectsAsync(string parent, IEnumerable<UpdateDataObjectRequest> requests, CancellationToken cancellationToken)

Updates dataObjects in a batch.

Parameters
Name Description
parent string

Required. The resource name of the Collection to update the DataObjects in. Format: projects/{project}/locations/{location}/collections/{collection}. The parent field in the UpdateDataObjectRequest messages must match this field.

requests IEnumerableUpdateDataObjectRequest

Required. The request message specifying the resources to update. A maximum of 1000 DataObjects can be updated in a batch.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBatchUpdateDataObjectsResponse

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
IEnumerable<UpdateDataObjectRequest> requests = new UpdateDataObjectRequest[]
{
    new UpdateDataObjectRequest(),
};
// Make the request
BatchUpdateDataObjectsResponse response = await dataObjectServiceClient.BatchUpdateDataObjectsAsync(parent, requests);

Create()

public static DataObjectServiceClient Create()

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

Returns
Type Description
DataObjectServiceClient

The created DataObjectServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDataObjectServiceClient

The task representing the created DataObjectServiceClient.

CreateDataObject(CollectionName, DataObject, string, CallSettings)

public virtual DataObject CreateDataObject(CollectionName parent, DataObject dataObject, string dataObjectId, CallSettings callSettings = null)

Creates a dataObject.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to create the DataObject in. Format: projects/{project}/locations/{location}/collections/{collection}

dataObject DataObject

Required. The DataObject to create.

dataObjectId string

Required. The id of the dataObject to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataObject

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
DataObject dataObject = new DataObject();
string dataObjectId = "";
// Make the request
DataObject response = dataObjectServiceClient.CreateDataObject(parent, dataObject, dataObjectId);

CreateDataObject(CreateDataObjectRequest, CallSettings)

public virtual DataObject CreateDataObject(CreateDataObjectRequest request, CallSettings callSettings = null)

Creates a dataObject.

Parameters
Name Description
request CreateDataObjectRequest

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
DataObject

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
CreateDataObjectRequest request = new CreateDataObjectRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    DataObjectId = "",
    DataObject = new DataObject(),
};
// Make the request
DataObject response = dataObjectServiceClient.CreateDataObject(request);

CreateDataObject(string, DataObject, string, CallSettings)

public virtual DataObject CreateDataObject(string parent, DataObject dataObject, string dataObjectId, CallSettings callSettings = null)

Creates a dataObject.

Parameters
Name Description
parent string

Required. The resource name of the Collection to create the DataObject in. Format: projects/{project}/locations/{location}/collections/{collection}

dataObject DataObject

Required. The DataObject to create.

dataObjectId string

Required. The id of the dataObject to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataObject

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
DataObject dataObject = new DataObject();
string dataObjectId = "";
// Make the request
DataObject response = dataObjectServiceClient.CreateDataObject(parent, dataObject, dataObjectId);

CreateDataObjectAsync(CollectionName, DataObject, string, CallSettings)

public virtual Task<DataObject> CreateDataObjectAsync(CollectionName parent, DataObject dataObject, string dataObjectId, CallSettings callSettings = null)

Creates a dataObject.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to create the DataObject in. Format: projects/{project}/locations/{location}/collections/{collection}

dataObject DataObject

Required. The DataObject to create.

dataObjectId string

Required. The id of the dataObject to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
DataObject dataObject = new DataObject();
string dataObjectId = "";
// Make the request
DataObject response = await dataObjectServiceClient.CreateDataObjectAsync(parent, dataObject, dataObjectId);

CreateDataObjectAsync(CollectionName, DataObject, string, CancellationToken)

public virtual Task<DataObject> CreateDataObjectAsync(CollectionName parent, DataObject dataObject, string dataObjectId, CancellationToken cancellationToken)

Creates a dataObject.

Parameters
Name Description
parent CollectionName

Required. The resource name of the Collection to create the DataObject in. Format: projects/{project}/locations/{location}/collections/{collection}

dataObject DataObject

Required. The DataObject to create.

dataObjectId string

Required. The id of the dataObject to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
CollectionName parent = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]");
DataObject dataObject = new DataObject();
string dataObjectId = "";
// Make the request
DataObject response = await dataObjectServiceClient.CreateDataObjectAsync(parent, dataObject, dataObjectId);

CreateDataObjectAsync(CreateDataObjectRequest, CallSettings)

public virtual Task<DataObject> CreateDataObjectAsync(CreateDataObjectRequest request, CallSettings callSettings = null)

Creates a dataObject.

Parameters
Name Description
request CreateDataObjectRequest

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
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDataObjectRequest request = new CreateDataObjectRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    DataObjectId = "",
    DataObject = new DataObject(),
};
// Make the request
DataObject response = await dataObjectServiceClient.CreateDataObjectAsync(request);

CreateDataObjectAsync(CreateDataObjectRequest, CancellationToken)

public virtual Task<DataObject> CreateDataObjectAsync(CreateDataObjectRequest request, CancellationToken cancellationToken)

Creates a dataObject.

Parameters
Name Description
request CreateDataObjectRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDataObjectRequest request = new CreateDataObjectRequest
{
    ParentAsCollectionName = CollectionName.FromProjectLocationCollection("[PROJECT]", "[LOCATION]", "[COLLECTION]"),
    DataObjectId = "",
    DataObject = new DataObject(),
};
// Make the request
DataObject response = await dataObjectServiceClient.CreateDataObjectAsync(request);

CreateDataObjectAsync(string, DataObject, string, CallSettings)

public virtual Task<DataObject> CreateDataObjectAsync(string parent, DataObject dataObject, string dataObjectId, CallSettings callSettings = null)

Creates a dataObject.

Parameters
Name Description
parent string

Required. The resource name of the Collection to create the DataObject in. Format: projects/{project}/locations/{location}/collections/{collection}

dataObject DataObject

Required. The DataObject to create.

dataObjectId string

Required. The id of the dataObject to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
DataObject dataObject = new DataObject();
string dataObjectId = "";
// Make the request
DataObject response = await dataObjectServiceClient.CreateDataObjectAsync(parent, dataObject, dataObjectId);

CreateDataObjectAsync(string, DataObject, string, CancellationToken)

public virtual Task<DataObject> CreateDataObjectAsync(string parent, DataObject dataObject, string dataObjectId, CancellationToken cancellationToken)

Creates a dataObject.

Parameters
Name Description
parent string

Required. The resource name of the Collection to create the DataObject in. Format: projects/{project}/locations/{location}/collections/{collection}

dataObject DataObject

Required. The DataObject to create.

dataObjectId string

Required. The id of the dataObject to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]";
DataObject dataObject = new DataObject();
string dataObjectId = "";
// Make the request
DataObject response = await dataObjectServiceClient.CreateDataObjectAsync(parent, dataObject, dataObjectId);

DeleteDataObject(DataObjectName, CallSettings)

public virtual void DeleteDataObject(DataObjectName name, CallSettings callSettings = null)

Deletes a dataObject.

Parameters
Name Description
name DataObjectName

Required. The name of the DataObject resource to be deleted. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
DataObjectName name = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]");
// Make the request
dataObjectServiceClient.DeleteDataObject(name);

DeleteDataObject(DeleteDataObjectRequest, CallSettings)

public virtual void DeleteDataObject(DeleteDataObjectRequest request, CallSettings callSettings = null)

Deletes a dataObject.

Parameters
Name Description
request DeleteDataObjectRequest

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
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
DeleteDataObjectRequest request = new DeleteDataObjectRequest
{
    DataObjectName = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]"),
    Etag = "",
};
// Make the request
dataObjectServiceClient.DeleteDataObject(request);

DeleteDataObject(string, CallSettings)

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

Deletes a dataObject.

Parameters
Name Description
name string

Required. The name of the DataObject resource to be deleted. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataObjects/[DATAOBJECT]";
// Make the request
dataObjectServiceClient.DeleteDataObject(name);

DeleteDataObjectAsync(DataObjectName, CallSettings)

public virtual Task DeleteDataObjectAsync(DataObjectName name, CallSettings callSettings = null)

Deletes a dataObject.

Parameters
Name Description
name DataObjectName

Required. The name of the DataObject resource to be deleted. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
DataObjectName name = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]");
// Make the request
await dataObjectServiceClient.DeleteDataObjectAsync(name);

DeleteDataObjectAsync(DataObjectName, CancellationToken)

public virtual Task DeleteDataObjectAsync(DataObjectName name, CancellationToken cancellationToken)

Deletes a dataObject.

Parameters
Name Description
name DataObjectName

Required. The name of the DataObject resource to be deleted. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
DataObjectName name = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]");
// Make the request
await dataObjectServiceClient.DeleteDataObjectAsync(name);

DeleteDataObjectAsync(DeleteDataObjectRequest, CallSettings)

public virtual Task DeleteDataObjectAsync(DeleteDataObjectRequest request, CallSettings callSettings = null)

Deletes a dataObject.

Parameters
Name Description
request DeleteDataObjectRequest

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
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDataObjectRequest request = new DeleteDataObjectRequest
{
    DataObjectName = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]"),
    Etag = "",
};
// Make the request
await dataObjectServiceClient.DeleteDataObjectAsync(request);

DeleteDataObjectAsync(DeleteDataObjectRequest, CancellationToken)

public virtual Task DeleteDataObjectAsync(DeleteDataObjectRequest request, CancellationToken cancellationToken)

Deletes a dataObject.

Parameters
Name Description
request DeleteDataObjectRequest

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
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDataObjectRequest request = new DeleteDataObjectRequest
{
    DataObjectName = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]"),
    Etag = "",
};
// Make the request
await dataObjectServiceClient.DeleteDataObjectAsync(request);

DeleteDataObjectAsync(string, CallSettings)

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

Deletes a dataObject.

Parameters
Name Description
name string

Required. The name of the DataObject resource to be deleted. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataObjects/[DATAOBJECT]";
// Make the request
await dataObjectServiceClient.DeleteDataObjectAsync(name);

DeleteDataObjectAsync(string, CancellationToken)

public virtual Task DeleteDataObjectAsync(string name, CancellationToken cancellationToken)

Deletes a dataObject.

Parameters
Name Description
name string

Required. The name of the DataObject resource to be deleted. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataObjects/[DATAOBJECT]";
// Make the request
await dataObjectServiceClient.DeleteDataObjectAsync(name);

GetDataObject(DataObjectName, CallSettings)

public virtual DataObject GetDataObject(DataObjectName name, CallSettings callSettings = null)

Gets a data object.

Parameters
Name Description
name DataObjectName

Required. The name of the DataObject resource. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataObject

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
DataObjectName name = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]");
// Make the request
DataObject response = dataObjectServiceClient.GetDataObject(name);

GetDataObject(GetDataObjectRequest, CallSettings)

public virtual DataObject GetDataObject(GetDataObjectRequest request, CallSettings callSettings = null)

Gets a data object.

Parameters
Name Description
request GetDataObjectRequest

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
DataObject

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
GetDataObjectRequest request = new GetDataObjectRequest
{
    DataObjectName = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]"),
};
// Make the request
DataObject response = dataObjectServiceClient.GetDataObject(request);

GetDataObject(string, CallSettings)

public virtual DataObject GetDataObject(string name, CallSettings callSettings = null)

Gets a data object.

Parameters
Name Description
name string

Required. The name of the DataObject resource. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataObject

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataObjects/[DATAOBJECT]";
// Make the request
DataObject response = dataObjectServiceClient.GetDataObject(name);

GetDataObjectAsync(DataObjectName, CallSettings)

public virtual Task<DataObject> GetDataObjectAsync(DataObjectName name, CallSettings callSettings = null)

Gets a data object.

Parameters
Name Description
name DataObjectName

Required. The name of the DataObject resource. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
DataObjectName name = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]");
// Make the request
DataObject response = await dataObjectServiceClient.GetDataObjectAsync(name);

GetDataObjectAsync(DataObjectName, CancellationToken)

public virtual Task<DataObject> GetDataObjectAsync(DataObjectName name, CancellationToken cancellationToken)

Gets a data object.

Parameters
Name Description
name DataObjectName

Required. The name of the DataObject resource. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
DataObjectName name = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]");
// Make the request
DataObject response = await dataObjectServiceClient.GetDataObjectAsync(name);

GetDataObjectAsync(GetDataObjectRequest, CallSettings)

public virtual Task<DataObject> GetDataObjectAsync(GetDataObjectRequest request, CallSettings callSettings = null)

Gets a data object.

Parameters
Name Description
request GetDataObjectRequest

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
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataObjectRequest request = new GetDataObjectRequest
{
    DataObjectName = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]"),
};
// Make the request
DataObject response = await dataObjectServiceClient.GetDataObjectAsync(request);

GetDataObjectAsync(GetDataObjectRequest, CancellationToken)

public virtual Task<DataObject> GetDataObjectAsync(GetDataObjectRequest request, CancellationToken cancellationToken)

Gets a data object.

Parameters
Name Description
request GetDataObjectRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataObjectRequest request = new GetDataObjectRequest
{
    DataObjectName = DataObjectName.FromProjectLocationCollectionDataObject("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATAOBJECT]"),
};
// Make the request
DataObject response = await dataObjectServiceClient.GetDataObjectAsync(request);

GetDataObjectAsync(string, CallSettings)

public virtual Task<DataObject> GetDataObjectAsync(string name, CallSettings callSettings = null)

Gets a data object.

Parameters
Name Description
name string

Required. The name of the DataObject resource. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataObjects/[DATAOBJECT]";
// Make the request
DataObject response = await dataObjectServiceClient.GetDataObjectAsync(name);

GetDataObjectAsync(string, CancellationToken)

public virtual Task<DataObject> GetDataObjectAsync(string name, CancellationToken cancellationToken)

Gets a data object.

Parameters
Name Description
name string

Required. The name of the DataObject resource. Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/collections/[COLLECTION]/dataObjects/[DATAOBJECT]";
// Make the request
DataObject response = await dataObjectServiceClient.GetDataObjectAsync(name);

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.

UpdateDataObject(DataObject, FieldMask, CallSettings)

public virtual DataObject UpdateDataObject(DataObject dataObject, FieldMask updateMask, CallSettings callSettings = null)

Updates a dataObject.

Parameters
Name Description
dataObject DataObject

Required. The DataObject which replaces the resource on the server.

updateMask FieldMask

Optional. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataObject

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
DataObject dataObject = new DataObject();
FieldMask updateMask = new FieldMask();
// Make the request
DataObject response = dataObjectServiceClient.UpdateDataObject(dataObject, updateMask);

UpdateDataObject(UpdateDataObjectRequest, CallSettings)

public virtual DataObject UpdateDataObject(UpdateDataObjectRequest request, CallSettings callSettings = null)

Updates a dataObject.

Parameters
Name Description
request UpdateDataObjectRequest

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
DataObject

The RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = DataObjectServiceClient.Create();
// Initialize request argument(s)
UpdateDataObjectRequest request = new UpdateDataObjectRequest
{
    DataObject = new DataObject(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataObject response = dataObjectServiceClient.UpdateDataObject(request);

UpdateDataObjectAsync(DataObject, FieldMask, CallSettings)

public virtual Task<DataObject> UpdateDataObjectAsync(DataObject dataObject, FieldMask updateMask, CallSettings callSettings = null)

Updates a dataObject.

Parameters
Name Description
dataObject DataObject

Required. The DataObject which replaces the resource on the server.

updateMask FieldMask

Optional. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
DataObject dataObject = new DataObject();
FieldMask updateMask = new FieldMask();
// Make the request
DataObject response = await dataObjectServiceClient.UpdateDataObjectAsync(dataObject, updateMask);

UpdateDataObjectAsync(DataObject, FieldMask, CancellationToken)

public virtual Task<DataObject> UpdateDataObjectAsync(DataObject dataObject, FieldMask updateMask, CancellationToken cancellationToken)

Updates a dataObject.

Parameters
Name Description
dataObject DataObject

Required. The DataObject which replaces the resource on the server.

updateMask FieldMask

Optional. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
DataObject dataObject = new DataObject();
FieldMask updateMask = new FieldMask();
// Make the request
DataObject response = await dataObjectServiceClient.UpdateDataObjectAsync(dataObject, updateMask);

UpdateDataObjectAsync(UpdateDataObjectRequest, CallSettings)

public virtual Task<DataObject> UpdateDataObjectAsync(UpdateDataObjectRequest request, CallSettings callSettings = null)

Updates a dataObject.

Parameters
Name Description
request UpdateDataObjectRequest

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
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataObjectRequest request = new UpdateDataObjectRequest
{
    DataObject = new DataObject(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataObject response = await dataObjectServiceClient.UpdateDataObjectAsync(request);

UpdateDataObjectAsync(UpdateDataObjectRequest, CancellationToken)

public virtual Task<DataObject> UpdateDataObjectAsync(UpdateDataObjectRequest request, CancellationToken cancellationToken)

Updates a dataObject.

Parameters
Name Description
request UpdateDataObjectRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataObject

A Task containing the RPC response.

Example
// Create client
DataObjectServiceClient dataObjectServiceClient = await DataObjectServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataObjectRequest request = new UpdateDataObjectRequest
{
    DataObject = new DataObject(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataObject response = await dataObjectServiceClient.UpdateDataObjectAsync(request);