Class UpdateStreamRequest.Builder (1.41.0)

public static final class UpdateStreamRequest.Builder extends GeneratedMessageV3.Builder<UpdateStreamRequest.Builder> implements UpdateStreamRequestOrBuilder

Request message for updating a stream.

Protobuf type google.cloud.datastream.v1.UpdateStreamRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public UpdateStreamRequest build()
Returns
Type Description
UpdateStreamRequest

buildPartial()

public UpdateStreamRequest buildPartial()
Returns
Type Description
UpdateStreamRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearForce()

public UpdateStreamRequest.Builder clearForce()

Optional. Update the stream without validating it.

bool force = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateStreamRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestId()

public UpdateStreamRequest.Builder clearRequestId()

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateStreamRequest.Builder

This builder for chaining.

clearStream()

public UpdateStreamRequest.Builder clearStream()

Required. The stream resource to update.

.google.cloud.datastream.v1.Stream stream = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UpdateStreamRequest.Builder

clearUpdateMask()

public UpdateStreamRequest.Builder clearUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateStreamRequest.Builder

clearValidateOnly()

public UpdateStreamRequest.Builder clearValidateOnly()

Optional. Only validate the stream with the changes, without actually updating it. The default is false.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateStreamRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public UpdateStreamRequest getDefaultInstanceForType()
Returns
Type Description
UpdateStreamRequest

getDescriptorForType()

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

getForce()

public boolean getForce()

Optional. Update the stream without validating it.

bool force = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The force.

getRequestId()

public String getRequestId()

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestId.

getStream()

public Stream getStream()

Required. The stream resource to update.

.google.cloud.datastream.v1.Stream stream = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Stream

The stream.

getStreamBuilder()

public Stream.Builder getStreamBuilder()

Required. The stream resource to update.

.google.cloud.datastream.v1.Stream stream = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Stream.Builder

getStreamOrBuilder()

public StreamOrBuilder getStreamOrBuilder()

Required. The stream resource to update.

.google.cloud.datastream.v1.Stream stream = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StreamOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

getValidateOnly()

public boolean getValidateOnly()

Optional. Only validate the stream with the changes, without actually updating it. The default is false.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasStream()

public boolean hasStream()

Required. The stream resource to update.

.google.cloud.datastream.v1.Stream stream = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the stream field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

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

mergeFrom(UpdateStreamRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeStream(Stream value)

public UpdateStreamRequest.Builder mergeStream(Stream value)

Required. The stream resource to update.

.google.cloud.datastream.v1.Stream stream = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Stream
Returns
Type Description
UpdateStreamRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateMask(FieldMask value)

public UpdateStreamRequest.Builder mergeUpdateMask(FieldMask value)

Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateStreamRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setForce(boolean value)

public UpdateStreamRequest.Builder setForce(boolean value)

Optional. Update the stream without validating it.

bool force = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The force to set.

Returns
Type Description
UpdateStreamRequest.Builder

This builder for chaining.

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

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

setRequestId(String value)

public UpdateStreamRequest.Builder setRequestId(String value)

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
UpdateStreamRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public UpdateStreamRequest.Builder setRequestIdBytes(ByteString value)

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
UpdateStreamRequest.Builder

This builder for chaining.

setStream(Stream value)

public UpdateStreamRequest.Builder setStream(Stream value)

Required. The stream resource to update.

.google.cloud.datastream.v1.Stream stream = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Stream
Returns
Type Description
UpdateStreamRequest.Builder

setStream(Stream.Builder builderForValue)

public UpdateStreamRequest.Builder setStream(Stream.Builder builderForValue)

Required. The stream resource to update.

.google.cloud.datastream.v1.Stream stream = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Stream.Builder
Returns
Type Description
UpdateStreamRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateMask(FieldMask value)

public UpdateStreamRequest.Builder setUpdateMask(FieldMask value)

Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateStreamRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateStreamRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateStreamRequest.Builder

setValidateOnly(boolean value)

public UpdateStreamRequest.Builder setValidateOnly(boolean value)

Optional. Only validate the stream with the changes, without actually updating it. The default is false.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
UpdateStreamRequest.Builder

This builder for chaining.