Class UpdateEngineRequest.Builder (0.41.0)

public static final class UpdateEngineRequest.Builder extends GeneratedMessageV3.Builder<UpdateEngineRequest.Builder> implements UpdateEngineRequestOrBuilder

Request message for EngineService.UpdateEngine method.

Protobuf type google.cloud.discoveryengine.v1alpha.UpdateEngineRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateEngineRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

build()

public UpdateEngineRequest build()
Returns
Type Description
UpdateEngineRequest

buildPartial()

public UpdateEngineRequest buildPartial()
Returns
Type Description
UpdateEngineRequest

clear()

public UpdateEngineRequest.Builder clear()
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

clearEngine()

public UpdateEngineRequest.Builder clearEngine()

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.v1alpha.Engine engine = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateEngineRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateEngineRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateEngineRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

clearUpdateMask()

public UpdateEngineRequest.Builder clearUpdateMask()

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
UpdateEngineRequest.Builder

clone()

public UpdateEngineRequest.Builder clone()
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateEngineRequest getDefaultInstanceForType()
Returns
Type Description
UpdateEngineRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.v1alpha.Engine engine = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Engine

The engine.

getEngineBuilder()

public Engine.Builder getEngineBuilder()

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.v1alpha.Engine engine = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Engine.Builder

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.v1alpha.Engine engine = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EngineOrBuilder

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.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
Builder

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.v1alpha.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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEngine(Engine value)

public UpdateEngineRequest.Builder mergeEngine(Engine value)

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.v1alpha.Engine engine = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Engine
Returns
Type Description
UpdateEngineRequest.Builder

mergeFrom(UpdateEngineRequest other)

public UpdateEngineRequest.Builder mergeFrom(UpdateEngineRequest other)
Parameter
Name Description
other UpdateEngineRequest
Returns
Type Description
UpdateEngineRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateEngineRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateEngineRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateEngineRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateEngineRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateEngineRequest.Builder mergeUpdateMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateEngineRequest.Builder

setEngine(Engine value)

public UpdateEngineRequest.Builder setEngine(Engine value)

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.v1alpha.Engine engine = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Engine
Returns
Type Description
UpdateEngineRequest.Builder

setEngine(Engine.Builder builderForValue)

public UpdateEngineRequest.Builder setEngine(Engine.Builder builderForValue)

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.v1alpha.Engine engine = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Engine.Builder
Returns
Type Description
UpdateEngineRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateEngineRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

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

public UpdateEngineRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateEngineRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateEngineRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateEngineRequest.Builder setUpdateMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateEngineRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateEngineRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateEngineRequest.Builder