Class CreateEngineRequest (0.31.0)

public final class CreateEngineRequest extends GeneratedMessageV3 implements CreateEngineRequestOrBuilder

Request for EngineService.CreateEngine method.

Protobuf type google.cloud.discoveryengine.v1.CreateEngineRequest

Static Fields

ENGINE_FIELD_NUMBER

public static final int ENGINE_FIELD_NUMBER
Field Value
TypeDescription
int

ENGINE_ID_FIELD_NUMBER

public static final int ENGINE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateEngineRequest getDefaultInstance()
Returns
TypeDescription
CreateEngineRequest

getDescriptor()

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

newBuilder()

public static CreateEngineRequest.Builder newBuilder()
Returns
TypeDescription
CreateEngineRequest.Builder

newBuilder(CreateEngineRequest prototype)

public static CreateEngineRequest.Builder newBuilder(CreateEngineRequest prototype)
Parameter
NameDescription
prototypeCreateEngineRequest
Returns
TypeDescription
CreateEngineRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateEngineRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateEngineRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateEngineRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateEngineRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateEngineRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateEngineRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateEngineRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateEngineRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateEngineRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateEngineRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateEngineRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateEngineRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateEngineRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateEngineRequest> parser()
Returns
TypeDescription
Parser<CreateEngineRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateEngineRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateEngineRequest

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.

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.

getParserForType()

public Parser<CreateEngineRequest> getParserForType()
Returns
TypeDescription
Parser<CreateEngineRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateEngineRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateEngineRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateEngineRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateEngineRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateEngineRequest.Builder toBuilder()
Returns
TypeDescription
CreateEngineRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException