Class UpdateEngineRequest (0.42.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
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateEngineRequest getDefaultInstance()
Returns
Type Description
UpdateEngineRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateEngineRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public UpdateEngineRequest getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
EngineOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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