Class CreateSampleQuerySetRequest (0.48.0)

public final class CreateSampleQuerySetRequest extends GeneratedMessageV3 implements CreateSampleQuerySetRequestOrBuilder

Request message for SampleQuerySetService.CreateSampleQuerySet method.

Protobuf type google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_QUERY_SET_FIELD_NUMBER

public static final int SAMPLE_QUERY_SET_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_QUERY_SET_ID_FIELD_NUMBER

public static final int SAMPLE_QUERY_SET_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateSampleQuerySetRequest getDefaultInstance()
Returns
Type Description
CreateSampleQuerySetRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateSampleQuerySetRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateSampleQuerySetRequest getDefaultInstanceForType()
Returns
Type Description
CreateSampleQuerySetRequest

getParent()

public String getParent()

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

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}.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSampleQuerySet()

public SampleQuerySet getSampleQuerySet()

Required. The SampleQuerySet to create.

.google.cloud.discoveryengine.v1alpha.SampleQuerySet sample_query_set = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SampleQuerySet

The sampleQuerySet.

getSampleQuerySetId()

public String getSampleQuerySetId()

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

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

This field must be unique among all SampleQuerySets 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_set_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The sampleQuerySetId.

getSampleQuerySetIdBytes()

public ByteString getSampleQuerySetIdBytes()

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

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

This field must be unique among all SampleQuerySets 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_set_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for sampleQuerySetId.

getSampleQuerySetOrBuilder()

public SampleQuerySetOrBuilder getSampleQuerySetOrBuilder()

Required. The SampleQuerySet to create.

.google.cloud.discoveryengine.v1alpha.SampleQuerySet sample_query_set = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SampleQuerySetOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasSampleQuerySet()

public boolean hasSampleQuerySet()

Required. The SampleQuerySet to create.

.google.cloud.discoveryengine.v1alpha.SampleQuerySet sample_query_set = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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