Interface UpdateStreamRequestOrBuilder (1.54.0)

public interface UpdateStreamRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getForce()

public abstract 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 abstract 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 abstract 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 abstract 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.

getStreamOrBuilder()

public abstract 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 abstract 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.

getUpdateMaskOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.