Class UpdateEngineRequest (0.32.0)

public final class UpdateEngineRequest extends GeneratedMessageV3 implements UpdateEngineRequestOrBuilder

Request message for EngineService.UpdateEngine method.

Protobuf type google.cloud.discoveryengine.v1.UpdateEngineRequest

Static Fields

ENGINE_FIELD_NUMBER

public static final int ENGINE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateEngineRequest getDefaultInstance()
Returns
TypeDescription
UpdateEngineRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateEngineRequest prototype)

public static UpdateEngineRequest.Builder newBuilder(UpdateEngineRequest prototype)
Parameter
NameDescription
prototypeUpdateEngineRequest
Returns
TypeDescription
UpdateEngineRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public UpdateEngineRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateEngineRequest

getEngine()

public Engine getEngine()

Required. The Engine to update.

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

If the Engine to update does not exist, a NOT_FOUND error is returned.

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

Returns
TypeDescription
Engine

The engine.

getEngineOrBuilder()

public EngineOrBuilder getEngineOrBuilder()

Required. The Engine to update.

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

If the Engine to update does not exist, a NOT_FOUND error is returned.

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

Returns
TypeDescription
EngineOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUpdateMask()

public FieldMask getUpdateMask()

Indicates which fields in the provided Engine to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Indicates which fields in the provided Engine to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
FieldMaskOrBuilder

hasEngine()

public boolean hasEngine()

Required. The Engine to update.

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

If the Engine to update does not exist, a NOT_FOUND error is returned.

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

Returns
TypeDescription
boolean

Whether the engine field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Indicates which fields in the provided Engine to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

.google.protobuf.FieldMask update_mask = 2;

Returns
TypeDescription
boolean

Whether the updateMask 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 UpdateEngineRequest.Builder newBuilderForType()
Returns
TypeDescription
UpdateEngineRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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