Class CreateSampleQueryRequest (0.43.0) 

public final class CreateSampleQueryRequest extends GeneratedMessageV3 implements CreateSampleQueryRequestOrBuilder

Request message for SampleQueryService.CreateSampleQuery method.

Protobuf type google.cloud.discoveryengine.v1beta.CreateSampleQueryRequest

Inheritance

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

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_QUERY_FIELD_NUMBER

public static final int SAMPLE_QUERY_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_QUERY_ID_FIELD_NUMBER

public static final int SAMPLE_QUERY_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateSampleQueryRequest getDefaultInstance()
Returns
Type Description
CreateSampleQueryRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateSampleQueryRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateSampleQueryRequest getDefaultInstanceForType()
Returns
Type Description
CreateSampleQueryRequest

getParent()

public String getParent()

Required. The parent resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSampleQuery()

public SampleQuery getSampleQuery()

Required. The SampleQuery to create.

.google.cloud.discoveryengine.v1beta.SampleQuery sample_query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SampleQuery

The sampleQuery.

getSampleQueryId()

public String getSampleQueryId()

Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name.

If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all SampleQuerys with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string sample_query_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The sampleQueryId.

getSampleQueryIdBytes()

public ByteString getSampleQueryIdBytes()

Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name.

If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all SampleQuerys with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string sample_query_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for sampleQueryId.

getSampleQueryOrBuilder()

public SampleQueryOrBuilder getSampleQueryOrBuilder()

Required. The SampleQuery to create.

.google.cloud.discoveryengine.v1beta.SampleQuery sample_query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SampleQueryOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasSampleQuery()

public boolean hasSampleQuery()

Required. The SampleQuery to create.

.google.cloud.discoveryengine.v1beta.SampleQuery sample_query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the sampleQuery 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 CreateSampleQueryRequest.Builder newBuilderForType()
Returns
Type Description
CreateSampleQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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