2022-05-08
▼ ▲ eventarc.projects.locations.channels.create
Description: Create a new channel in a particular project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/channels
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/channels
HTTP Method: POST
Parameters:
validateOnly
Type: boolean
Description: Required. If set, validate the request and preview the review, but do not post it.
Location: query
channelId
Location: query
Type: string
Description: Required. The user-provided ID to be assigned to the channel.
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Description: Required. The parent collection in which to add this channel.
Parameter Order: parent
▼ ▲ eventarc.projects.locations.channels.delete
Parameter Order: name
Parameters:
name
Location: path
Description: Required. The name of the channel to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/channels/[^/]+$
Required: Yes
Type: string
validateOnly
Location: query
Description: Required. If set, validate the request and preview the review, but do not post it.
Type: boolean
HTTP Method: DELETE
Description: Delete a single channel.
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/channels/{channelsId}
▼ ▲ eventarc.projects.locations.channels.list
HTTP Method: GET
Description: List channels.
Parameters:
pageSize
Format: int32
Type: integer
Description: The maximum number of channels to return on each page. Note: The service may send fewer.
Location: query
pageToken
Location: query
Type: string
Description: The page token; provide the value from the `next_page_token` field in a previous `ListChannels` call to retrieve the subsequent page. When paginating, all other parameters provided to `ListChannels` must match the call that provided the page token.
parent
Description: Required. The parent collection to list channels on.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
orderBy
Location: query
Type: string
Description: The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, channel_id`.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/channels
Path: v1/{+parent}/channels
Parameter Order: parent
▼ ▲ eventarc.projects.locations.channels.patch
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Parameters:
name
Type: string
Location: path
Description: 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.
Pattern: ^projects/[^/]+/locations/[^/]+/channels/[^/]+$
Required: Yes
validateOnly
Location: query
Description: Required. If set, validate the request and preview the review, but do not post it.
Type: boolean
updateMask
Location: query
Description: The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
Format: google-fieldmask
Type: string
Path: v1/{+name}
Description: Update a single channel.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/channels/{channelsId}
▼ ▲ eventarc.projects.locations.channels.get
Description: Get a single Channel.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/channels/{channelsId}
Parameters:
name
Location: path
Type: string
Description: Required. The name of the channel to get.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/channels/[^/]+$
HTTP Method: GET