Class CreateSampleQueryRequest.Builder (0.45.0)

public static final class CreateSampleQueryRequest.Builder extends GeneratedMessageV3.Builder<CreateSampleQueryRequest.Builder> implements CreateSampleQueryRequestOrBuilder

Request message for SampleQueryService.CreateSampleQuery method.

Protobuf type google.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest

Inheritance

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

Implements

CreateSampleQueryRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateSampleQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CreateSampleQueryRequest build()

Returns
Type	Description
`CreateSampleQueryRequest`

buildPartial()

public CreateSampleQueryRequest buildPartial()

Returns
Type	Description
`CreateSampleQueryRequest`

clear()

public CreateSampleQueryRequest.Builder clear()

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public CreateSampleQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateSampleQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParent()

public CreateSampleQueryRequest.Builder clearParent()

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
`CreateSampleQueryRequest.Builder`	This builder for chaining.

clearSampleQuery()

public CreateSampleQueryRequest.Builder clearSampleQuery()

Required. The SampleQuery to create.

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

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

clearSampleQueryId()

public CreateSampleQueryRequest.Builder clearSampleQueryId()

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
`CreateSampleQueryRequest.Builder`	This builder for chaining.

clone()

public CreateSampleQueryRequest.Builder clone()

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public CreateSampleQueryRequest getDefaultInstanceForType()

Returns
Type	Description
`CreateSampleQueryRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getSampleQuery()

public SampleQuery getSampleQuery()

Required. The SampleQuery to create.

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

Returns
Type	Description
`SampleQuery`	The sampleQuery.

getSampleQueryBuilder()

public SampleQuery.Builder getSampleQueryBuilder()

Required. The SampleQuery to create.

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

Returns
Type	Description
`SampleQuery.Builder`

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.v1alpha.SampleQuery sample_query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`SampleQueryOrBuilder`

hasSampleQuery()

public boolean hasSampleQuery()

Required. The SampleQuery to create.

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

Returns
Type	Description
`boolean`	Whether the sampleQuery field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CreateSampleQueryRequest other)

public CreateSampleQueryRequest.Builder mergeFrom(CreateSampleQueryRequest other)

Parameter
Name	Description
`other`	`CreateSampleQueryRequest`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateSampleQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public CreateSampleQueryRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSampleQuery(SampleQuery value)

public CreateSampleQueryRequest.Builder mergeSampleQuery(SampleQuery value)

Required. The SampleQuery to create.

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

Parameter
Name	Description
`value`	`SampleQuery`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateSampleQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public CreateSampleQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setParent(String value)

public CreateSampleQueryRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name	Description
`value`	`String` The parent to set.

Returns
Type	Description
`CreateSampleQueryRequest.Builder`	This builder for chaining.

setParentBytes(ByteString value)

public CreateSampleQueryRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for parent to set.

Returns
Type	Description
`CreateSampleQueryRequest.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateSampleQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSampleQuery(SampleQuery value)

public CreateSampleQueryRequest.Builder setSampleQuery(SampleQuery value)

Required. The SampleQuery to create.

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

Parameter
Name	Description
`value`	`SampleQuery`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

setSampleQuery(SampleQuery.Builder builderForValue)

public CreateSampleQueryRequest.Builder setSampleQuery(SampleQuery.Builder builderForValue)

Required. The SampleQuery to create.

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

Parameter
Name	Description
`builderForValue`	`SampleQuery.Builder`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

setSampleQueryId(String value)

public CreateSampleQueryRequest.Builder setSampleQueryId(String value)

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];

Parameter
Name	Description
`value`	`String` The sampleQueryId to set.

Returns
Type	Description
`CreateSampleQueryRequest.Builder`	This builder for chaining.

setSampleQueryIdBytes(ByteString value)

public CreateSampleQueryRequest.Builder setSampleQueryIdBytes(ByteString value)

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];

Parameter
Name	Description
`value`	`ByteString` The bytes for sampleQueryId to set.

Returns
Type	Description
`CreateSampleQueryRequest.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateSampleQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`CreateSampleQueryRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)