Interface StartDistributionRequestOrBuilder (0.77.0)

public interface StartDistributionRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDistributionKeys(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the distributionKeys.

getName()

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

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

Returns
Type Description
ByteString

The bytes for requestId.