Class ProjectsResource.LocationsResource.DatasetsResource.SearchDataItemsRequest

Searches DataItems in a Dataset.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudAiplatformV1SearchDataItemsResponse>
AiplatformBaseServiceRequest<GoogleCloudAiplatformV1SearchDataItemsResponse>
ProjectsResource.LocationsResource.DatasetsResource.SearchDataItemsRequest
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class ProjectsResource.LocationsResource.DatasetsResource.SearchDataItemsRequest : AiplatformBaseServiceRequest<GoogleCloudAiplatformV1SearchDataItemsResponse>, IClientServiceRequest<GoogleCloudAiplatformV1SearchDataItemsResponse>, IClientServiceRequest

Constructors

SearchDataItemsRequest(IClientService, string)

Constructs a new SearchDataItems request.

Declaration
public SearchDataItemsRequest(IClientService service, string dataset)
Parameters
Type Name Description
IClientService service
string dataset

Properties

AnnotationFilters

An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * annotation_spec_id - for = or !=. Must specify saved_query_id= - saved query id that annotations should belong to.

Declaration
[RequestParameter("annotationFilters", RequestParameterType.Query)]
public virtual Repeatable<string> AnnotationFilters { get; set; }
Property Value
Type Description
Repeatable<string>

AnnotationsFilter

An expression for filtering the Annotations that will be returned per DataItem. * annotation_spec_id - for = or !=.

Declaration
[RequestParameter("annotationsFilter", RequestParameterType.Query)]
public virtual string AnnotationsFilter { get; set; }
Property Value
Type Description
string

AnnotationsLimit

If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.

Declaration
[RequestParameter("annotationsLimit", RequestParameterType.Query)]
public virtual int? AnnotationsLimit { get; set; }
Property Value
Type Description
int?

DataItemFilter

An expression for filtering the DataItem that will be returned. * data_item_id - for = or !=.

  • labeled - for = or !=. * has_annotation(ANNOTATION_SPEC_ID) - true only for DataItem that have at least one annotation with annotation_spec_id = ANNOTATION_SPEC_ID in the context of SavedQuery or DataLabelingJob. For example: * data_item=1 * has_annotation(5)
Declaration
[RequestParameter("dataItemFilter", RequestParameterType.Query)]
public virtual string DataItemFilter { get; set; }
Property Value
Type Description
string

DataLabelingJob

The resource name of a DataLabelingJob. Format: projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job} If this field is set, all of the search will be done in the context of this DataLabelingJob.

Declaration
[RequestParameter("dataLabelingJob", RequestParameterType.Query)]
public virtual string DataLabelingJob { get; set; }
Property Value
Type Description
string

Dataset

Required. The resource name of the Dataset from which to search DataItems. Format: projects/{project}/locations/{location}/datasets/{dataset}

Declaration
[RequestParameter("dataset", RequestParameterType.Path)]
public virtual string Dataset { get; }
Property Value
Type Description
string

FieldMask

Mask specifying which fields of DataItemView to read.

Declaration
[RequestParameter("fieldMask", RequestParameterType.Query)]
public virtual object FieldMask { get; set; }
Property Value
Type Description
object

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderBy

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

OrderByAnnotationOrderBy

A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

Declaration
[RequestParameter("orderByAnnotation.orderBy", RequestParameterType.Query)]
public virtual string OrderByAnnotationOrderBy { get; set; }
Property Value
Type Description
string

OrderByAnnotationSavedQuery

Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

Declaration
[RequestParameter("orderByAnnotation.savedQuery", RequestParameterType.Query)]
public virtual string OrderByAnnotationSavedQuery { get; set; }
Property Value
Type Description
string

OrderByDataItem

A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

Declaration
[RequestParameter("orderByDataItem", RequestParameterType.Query)]
public virtual string OrderByDataItem { get; set; }
Property Value
Type Description
string

PageSize

Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SavedQuery

The resource name of a SavedQuery(annotation set in UI). Format: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query} All of the search will be done in the context of this SavedQuery.

Declaration
[RequestParameter("savedQuery", RequestParameterType.Query)]
public virtual string SavedQuery { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes SearchDataItems parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements