Vertex AI v1beta1 API - Class FetchExamplesRequest (1.0.0-beta24) 

public sealed class FetchExamplesRequest : IMessage<FetchExamplesRequest>, IEquatable<FetchExamplesRequest>, IDeepCloneable<FetchExamplesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Vertex AI v1beta1 API class FetchExamplesRequest.

Request message for [ExampleStoreService.FetchExamples][google.cloud.aiplatform.v1beta1.ExampleStoreService.FetchExamples].

Inheritance

object > FetchExamplesRequest

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

FetchExamplesRequest()

public FetchExamplesRequest()

FetchExamplesRequest(FetchExamplesRequest)

public FetchExamplesRequest(FetchExamplesRequest other)
Parameter
Name Description
other FetchExamplesRequest

Properties

ExampleIds

public RepeatedField<string> ExampleIds { get; }

Optional. Example IDs to fetch. If both metadata filters and Example IDs are specified, then both ID and metadata filtering will be applied.

Property Value
Type Description
RepeatedFieldstring

ExampleStore

public string ExampleStore { get; set; }

Required. The name of the ExampleStore resource that the examples should be fetched from. Format: projects/{project}/locations/{location}/exampleStores/{example_store}

Property Value
Type Description
string

ExampleStoreAsExampleStoreName

public ExampleStoreName ExampleStoreAsExampleStoreName { get; set; }

ExampleStoreName-typed view over the ExampleStore resource name property.

Property Value
Type Description
ExampleStoreName

MetadataFilterCase

public FetchExamplesRequest.MetadataFilterOneofCase MetadataFilterCase { get; }
Property Value
Type Description
FetchExamplesRequestMetadataFilterOneofCase

PageSize

public int PageSize { get; set; }

Optional. The maximum number of examples to return. The service may return fewer than this value. If unspecified, at most 100 examples will be returned.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. The [next_page_token][google.cloud.aiplatform.v1beta1.FetchExamplesResponse.next_page_token] value returned from a previous list [ExampleStoreService.FetchExamplesResponse][] call.

Property Value
Type Description
string

StoredContentsExampleFilter

public StoredContentsExampleFilter StoredContentsExampleFilter { get; set; }

The metadata filters for StoredContentsExamples.

Property Value
Type Description
StoredContentsExampleFilter