Class StartDistributionRequest.Builder (0.85.0)

public static final class StartDistributionRequest.Builder extends GeneratedMessage.Builder<StartDistributionRequest.Builder> implements StartDistributionRequestOrBuilder

Request message for "LivestreamService.StartDistribution".

Protobuf type google.cloud.video.livestream.v1.StartDistributionRequest

Static Methods

getDescriptor()

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

Methods

addAllDistributionKeys(Iterable<String> values)

public StartDistributionRequest.Builder addAllDistributionKeys(Iterable<String> values)

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The distributionKeys to add.

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

addDistributionKeys(String value)

public StartDistributionRequest.Builder addDistributionKeys(String value)

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The distributionKeys to add.

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

addDistributionKeysBytes(ByteString value)

public StartDistributionRequest.Builder addDistributionKeysBytes(ByteString value)

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the distributionKeys to add.

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

build()

public StartDistributionRequest build()
Returns
Type Description
StartDistributionRequest

buildPartial()

public StartDistributionRequest buildPartial()
Returns
Type Description
StartDistributionRequest

clear()

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

clearDistributionKeys()

public StartDistributionRequest.Builder clearDistributionKeys()

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

clearName()

public StartDistributionRequest.Builder clearName()

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

clearRequestId()

public StartDistributionRequest.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, (.google.api.field_info) = { ... }

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public StartDistributionRequest getDefaultInstanceForType()
Returns
Type Description
StartDistributionRequest

getDescriptorForType()

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

getDistributionKeys(int index)

public String getDistributionKeys(int index)

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The distributionKeys at the given index.

getDistributionKeysBytes(int index)

public ByteString getDistributionKeysBytes(int index)

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the distributionKeys at the given index.

getDistributionKeysCount()

public int getDistributionKeysCount()

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of distributionKeys.

getDistributionKeysList()

public ProtocolStringList getDistributionKeysList()

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the distributionKeys.

getName()

public String getName()

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

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, (.google.api.field_info) = { ... }

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, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StartDistributionRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setDistributionKeys(int index, String value)

public StartDistributionRequest.Builder setDistributionKeys(int index, String value)

Optional. A list of keys to identify the distribution configuration in the channel resource. If left empty, all the distributions in the channel specification will be started.

repeated string distribution_keys = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The distributionKeys to set.

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

setName(String value)

public StartDistributionRequest.Builder setName(String value)

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public StartDistributionRequest.Builder setNameBytes(ByteString value)

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

setRequestId(String value)

public StartDistributionRequest.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, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public StartDistributionRequest.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, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
StartDistributionRequest.Builder

This builder for chaining.