Class SampleQuery (0.45.0) 

public final class SampleQuery extends GeneratedMessageV3 implements SampleQueryOrBuilder

Sample Query captures metadata to be used for evaluation.

Protobuf type google.cloud.discoveryengine.v1alpha.SampleQuery

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SampleQuery

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

QUERY_ENTRY_FIELD_NUMBER

public static final int QUERY_ENTRY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SampleQuery getDefaultInstance()
Returns
Type Description
SampleQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SampleQuery.Builder newBuilder()
Returns
Type Description
SampleQuery.Builder

newBuilder(SampleQuery prototype)

public static SampleQuery.Builder newBuilder(SampleQuery prototype)
Parameter
Name Description
prototype SampleQuery
Returns
Type Description
SampleQuery.Builder

parseDelimitedFrom(InputStream input)

public static SampleQuery parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SampleQuery
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SampleQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SampleQuery parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SampleQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SampleQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SampleQuery parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SampleQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SampleQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SampleQuery parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SampleQuery
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SampleQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SampleQuery parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SampleQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SampleQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SampleQuery parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SampleQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SampleQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SampleQuery> parser()
Returns
Type Description
Parser<SampleQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContentCase()

public SampleQuery.ContentCase getContentCase()
Returns
Type Description
SampleQuery.ContentCase

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp the SampleQuery was created at.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp the SampleQuery was created at.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public SampleQuery getDefaultInstanceForType()
Returns
Type Description
SampleQuery

getName()

public String getName()

Identifier. The full resource name of the sample query, in the format of projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The full resource name of the sample query, in the format of projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<SampleQuery> getParserForType()
Returns
Type Description
Parser<SampleQuery>
Overrides

getQueryEntry()

public SampleQuery.QueryEntry getQueryEntry()

The query entry.

.google.cloud.discoveryengine.v1alpha.SampleQuery.QueryEntry query_entry = 2;

Returns
Type Description
SampleQuery.QueryEntry

The queryEntry.

getQueryEntryOrBuilder()

public SampleQuery.QueryEntryOrBuilder getQueryEntryOrBuilder()

The query entry.

.google.cloud.discoveryengine.v1alpha.SampleQuery.QueryEntry query_entry = 2;

Returns
Type Description
SampleQuery.QueryEntryOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp the SampleQuery was created at.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasQueryEntry()

public boolean hasQueryEntry()

The query entry.

.google.cloud.discoveryengine.v1alpha.SampleQuery.QueryEntry query_entry = 2;

Returns
Type Description
boolean

Whether the queryEntry field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SampleQuery.Builder newBuilderForType()
Returns
Type Description
SampleQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SampleQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SampleQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SampleQuery.Builder toBuilder()
Returns
Type Description
SampleQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException