Class protos.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest (3.11.0)

Represents a SearchDataItemsRequest.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest);

Constructs a new SearchDataItemsRequest.

Parameter
NameDescription
properties ISearchDataItemsRequest

Properties to set

Properties

annotationFilters

public annotationFilters: string[];

SearchDataItemsRequest annotationFilters.

annotationsFilter

public annotationsFilter: string;

SearchDataItemsRequest annotationsFilter.

annotationsLimit

public annotationsLimit: number;

SearchDataItemsRequest annotationsLimit.

dataItemFilter

public dataItemFilter: string;

SearchDataItemsRequest dataItemFilter.

dataLabelingJob

public dataLabelingJob: string;

SearchDataItemsRequest dataLabelingJob.

dataset

public dataset: string;

SearchDataItemsRequest dataset.

fieldMask

public fieldMask?: (google.protobuf.IFieldMask|null);

SearchDataItemsRequest fieldMask.

order

public order?: ("orderByDataItem"|"orderByAnnotation");

SearchDataItemsRequest order.

orderBy

public orderBy: string;

SearchDataItemsRequest orderBy.

orderByAnnotation

public orderByAnnotation?: (google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation|null);

SearchDataItemsRequest orderByAnnotation.

orderByDataItem

public orderByDataItem?: (string|null);

SearchDataItemsRequest orderByDataItem.

pageSize

public pageSize: number;

SearchDataItemsRequest pageSize.

pageToken

public pageToken: string;

SearchDataItemsRequest pageToken.

savedQuery

public savedQuery: string;

SearchDataItemsRequest savedQuery.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest;

Creates a new SearchDataItemsRequest instance using the specified properties.

Parameter
NameDescription
properties ISearchDataItemsRequest

Properties to set

Returns
TypeDescription
SearchDataItemsRequest

SearchDataItemsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest;

Decodes a SearchDataItemsRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
SearchDataItemsRequest

SearchDataItemsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest;

Decodes a SearchDataItemsRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SearchDataItemsRequest

SearchDataItemsRequest

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SearchDataItemsRequest message. Does not implicitly messages.

Parameters
NameDescription
message ISearchDataItemsRequest

SearchDataItemsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SearchDataItemsRequest message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message ISearchDataItemsRequest

SearchDataItemsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest;

Creates a SearchDataItemsRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
SearchDataItemsRequest

SearchDataItemsRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SearchDataItemsRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this SearchDataItemsRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1beta1.SearchDataItemsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a SearchDataItemsRequest message. Also converts values to other types if specified.

Parameters
NameDescription
message SearchDataItemsRequest

SearchDataItemsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SearchDataItemsRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not