Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class DeleteChannelRequest.
Request message for "LivestreamService.DeleteChannel".
Generated from protobuf message google.cloud.video.livestream.v1.DeleteChannelRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the channel resource, in the form of: |
↳ request_id |
string
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 after 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 |
↳ force |
bool
If the |
getName
Required. The name of the channel resource, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The name of the channel resource, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestId
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 after 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).
| Returns | |
|---|---|
| Type | Description |
string | |
setRequestId
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 after 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).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getForce
If the force field is set to the default value of false, you must
delete all of a channel's events before you can delete the channel itself.
If the field is set to true, requests to delete a channel also delete
associated channel events.
| Returns | |
|---|---|
| Type | Description |
bool | |
setForce
If the force field is set to the default value of false, you must
delete all of a channel's events before you can delete the channel itself.
If the field is set to true, requests to delete a channel also delete
associated channel events.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |