Class CreateEngineRequest.Builder (0.37.0)

public static final class CreateEngineRequest.Builder extends GeneratedMessageV3.Builder<CreateEngineRequest.Builder> implements CreateEngineRequestOrBuilder

Request for EngineService.CreateEngine method.

Protobuf type google.cloud.discoveryengine.v1.CreateEngineRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateEngineRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

build()

public CreateEngineRequest build()
Returns
TypeDescription
CreateEngineRequest

buildPartial()

public CreateEngineRequest buildPartial()
Returns
TypeDescription
CreateEngineRequest

clear()

public CreateEngineRequest.Builder clear()
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

clearEngine()

public CreateEngineRequest.Builder clearEngine()

Required. The Engine to create.

.google.cloud.discoveryengine.v1.Engine engine = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CreateEngineRequest.Builder

clearEngineId()

public CreateEngineRequest.Builder clearEngineId()

Required. The ID to use for the Engine, which will become the final component of the Engine's resource name.

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

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

Returns
TypeDescription
CreateEngineRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateEngineRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateEngineRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

clearParent()

public CreateEngineRequest.Builder clearParent()

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

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

Returns
TypeDescription
CreateEngineRequest.Builder

This builder for chaining.

clone()

public CreateEngineRequest.Builder clone()
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

getDefaultInstanceForType()

public CreateEngineRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateEngineRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEngine()

public Engine getEngine()

Required. The Engine to create.

.google.cloud.discoveryengine.v1.Engine engine = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Engine

The engine.

getEngineBuilder()

public Engine.Builder getEngineBuilder()

Required. The Engine to create.

.google.cloud.discoveryengine.v1.Engine engine = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Engine.Builder

getEngineId()

public String getEngineId()

Required. The ID to use for the Engine, which will become the final component of the Engine's resource name.

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

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

Returns
TypeDescription
String

The engineId.

getEngineIdBytes()

public ByteString getEngineIdBytes()

Required. The ID to use for the Engine, which will become the final component of the Engine's resource name.

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

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

Returns
TypeDescription
ByteString

The bytes for engineId.

getEngineOrBuilder()

public EngineOrBuilder getEngineOrBuilder()

Required. The Engine to create.

.google.cloud.discoveryengine.v1.Engine engine = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
EngineOrBuilder

getParent()

public String getParent()

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

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for parent.

hasEngine()

public boolean hasEngine()

Required. The Engine to create.

.google.cloud.discoveryengine.v1.Engine engine = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the engine field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEngine(Engine value)

public CreateEngineRequest.Builder mergeEngine(Engine value)

Required. The Engine to create.

.google.cloud.discoveryengine.v1.Engine engine = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEngine
Returns
TypeDescription
CreateEngineRequest.Builder

mergeFrom(CreateEngineRequest other)

public CreateEngineRequest.Builder mergeFrom(CreateEngineRequest other)
Parameter
NameDescription
otherCreateEngineRequest
Returns
TypeDescription
CreateEngineRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateEngineRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CreateEngineRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateEngineRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

setEngine(Engine value)

public CreateEngineRequest.Builder setEngine(Engine value)

Required. The Engine to create.

.google.cloud.discoveryengine.v1.Engine engine = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEngine
Returns
TypeDescription
CreateEngineRequest.Builder

setEngine(Engine.Builder builderForValue)

public CreateEngineRequest.Builder setEngine(Engine.Builder builderForValue)

Required. The Engine to create.

.google.cloud.discoveryengine.v1.Engine engine = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueEngine.Builder
Returns
TypeDescription
CreateEngineRequest.Builder

setEngineId(String value)

public CreateEngineRequest.Builder setEngineId(String value)

Required. The ID to use for the Engine, which will become the final component of the Engine's resource name.

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

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

Parameter
NameDescription
valueString

The engineId to set.

Returns
TypeDescription
CreateEngineRequest.Builder

This builder for chaining.

setEngineIdBytes(ByteString value)

public CreateEngineRequest.Builder setEngineIdBytes(ByteString value)

Required. The ID to use for the Engine, which will become the final component of the Engine's resource name.

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

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

Parameter
NameDescription
valueByteString

The bytes for engineId to set.

Returns
TypeDescription
CreateEngineRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateEngineRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

setParent(String value)

public CreateEngineRequest.Builder setParent(String value)

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

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
CreateEngineRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateEngineRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
CreateEngineRequest.Builder

This builder for chaining.

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

public CreateEngineRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateEngineRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides