class ProjectsLocationsChannels extends Resource (View source)

The "channels" collection of methods.

Typical usage is:

 $eventarcService = new Google\Service\Eventarc(...);
 $channels = $eventarcService->projects_locations_channels;

Methods

create(string $parent, Channel $postBody, array $optParams = [])

Create a new channel in a particular project and location. (channels.create)

delete(string $name, array $optParams = [])

Delete a single channel. (channels.delete)

get(string $name, array $optParams = [])

Get a single Channel. (channels.get)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (channels.getIamPolicy)

listProjectsLocationsChannels(string $parent, array $optParams = [])

List channels. (channels.listProjectsLocationsChannels)

patch(string $name, Channel $postBody, array $optParams = [])

Update a single channel. (channels.patch)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (channels.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

GoogleLongrunningOperation create(string $parent, Channel $postBody, array $optParams = [])

Create a new channel in a particular project and location. (channels.create)

Parameters

string $parent

Required. The parent collection in which to add this channel.

Channel $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

Delete a single channel. (channels.delete)

Parameters

string $name

Required. The name of the channel to be deleted.

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

Channel get(string $name, array $optParams = [])

Get a single Channel. (channels.get)

Parameters

string $name

Required. The name of the channel to get.

array $optParams

Optional parameters.

Return Value

Channel

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (channels.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

ListChannelsResponse listProjectsLocationsChannels(string $parent, array $optParams = [])

List channels. (channels.listProjectsLocationsChannels)

Parameters

string $parent

Required. The parent collection to list channels on.

array $optParams

Optional parameters.

Return Value

ListChannelsResponse

Exceptions

Exception

GoogleLongrunningOperation patch(string $name, Channel $postBody, array $optParams = [])

Update a single channel. (channels.patch)

Parameters

string $name

Required. The resource name of the channel. Must be unique within the location on the project and must be in projects/{project}/locations/{location}/channels/{channel_id} format.

Channel $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (channels.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (channels.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception