DataStream v1 API - Class UpdateStreamRequest (2.2.0)

public sealed class UpdateStreamRequest : IMessage<UpdateStreamRequest>, IEquatable<UpdateStreamRequest>, IDeepCloneable<UpdateStreamRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the DataStream v1 API class UpdateStreamRequest.

Request message for updating a stream.

Inheritance

Object > UpdateStreamRequest

Implements

IMessage<UpdateStreamRequest>, IEquatable<UpdateStreamRequest>, IDeepCloneable<UpdateStreamRequest>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

UpdateStreamRequest()

public UpdateStreamRequest()

UpdateStreamRequest(UpdateStreamRequest)

public UpdateStreamRequest(UpdateStreamRequest other)

Parameter
Name	Description
`other`	`UpdateStreamRequest`

Properties

Force

public bool Force { get; set; }

Optional. Update the stream without validating it.

Property Value
Type	Description
`Boolean`

RequestId

public string RequestId { get; set; }

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

Property Value
Type	Description
`String`

Stream

public Stream Stream { get; set; }

Required. The stream resource to update.

Property Value
Type	Description
`Stream`

UpdateMask

public FieldMask UpdateMask { get; set; }

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.

Property Value
Type	Description
`FieldMask`

ValidateOnly

public bool ValidateOnly { get; set; }

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

Property Value
Type	Description
`Boolean`