2024-10-26
▼ ▲ eventarc.projects.locations.messageBuses.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the message bus to get.
Pattern : ^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a single MessageBus.
▼ ▲ eventarc.projects.locations.messageBuses.list
Path : v1/{+parent}/messageBuses
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/messageBuses
HTTP Method : GET
Parameters :
parent
Description : Required. The parent collection to list triggers on.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return on each page. Note: The service may send fewer.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. 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, update_time`.
Location : query
Type : string
filter
Description : Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List message buses.
▼ ▲ eventarc.projects.locations.messageBuses.listEnrollments
Path : v1/{+parent}:listEnrollments
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:listEnrollments
HTTP Method : GET
Parameters :
parent
Description : Required. The parent message bus to list enrollments on.
Pattern : ^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return on each page. Note: The service may send fewer.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List message bus enrollments.
▼ ▲ eventarc.projects.locations.messageBuses.create
Path : v1/{+parent}/messageBuses
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/messageBuses
HTTP Method : POST
Parameters :
parent
Description : Required. The parent collection in which to add this message bus.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
messageBusId
Description : Required. The user-provided ID to be assigned to the MessageBus. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$)
Location : query
Type : string
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a new MessageBus in a particular project and location.
▼ ▲ eventarc.projects.locations.messageBuses.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
Pattern : ^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. 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 "*".
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : Optional. If set to true, and the MessageBus is not found, a new MessageBus will be created. In this situation, `update_mask` is ignored.
Location : query
Type : boolean
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a single message bus.
▼ ▲ eventarc.projects.locations.messageBuses.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the MessageBus to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/messageBuses/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.
Location : query
Type : string
allowMissing
Description : Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.
Location : query
Type : boolean
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a single message bus.
▼ ▲ eventarc.projects.locations.enrollments.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the Enrollment to get.
Pattern : ^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a single Enrollment.
▼ ▲ eventarc.projects.locations.enrollments.list
Path : v1/{+parent}/enrollments
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/enrollments
HTTP Method : GET
Parameters :
parent
Description : Required. The parent collection to list triggers on.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return on each page. Note: The service may send fewer.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. 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, update_time`.
Location : query
Type : string
filter
Description : Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List Enrollments.
▼ ▲ eventarc.projects.locations.enrollments.create
Path : v1/{+parent}/enrollments
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/enrollments
HTTP Method : POST
Parameters :
parent
Description : Required. The parent collection in which to add this enrollment.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
enrollmentId
Description : Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
Location : query
Type : string
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a new Enrollment in a particular project and location.
▼ ▲ eventarc.projects.locations.enrollments.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
Pattern : ^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. 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 "*".
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : Optional. If set to true, and the Enrollment is not found, a new Enrollment will be created. In this situation, `update_mask` is ignored.
Location : query
Type : boolean
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a single Enrollment.
▼ ▲ eventarc.projects.locations.enrollments.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Enrollment to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/enrollments/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. If provided, the Enrollment will only be deleted if the etag matches the current etag on the resource.
Location : query
Type : string
allowMissing
Description : Optional. If set to true, and the Enrollment is not found, the request will succeed but no action will be taken on the server.
Location : query
Type : boolean
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a single Enrollment.
▼ ▲ eventarc.projects.locations.pipelines.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the pipeline to get.
Pattern : ^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a single Pipeline.
▼ ▲ eventarc.projects.locations.pipelines.list
Path : v1/{+parent}/pipelines
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/pipelines
HTTP Method : GET
Parameters :
parent
Description : Required. The parent collection to list pipelines on.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return on each page. Note: The service may send fewer.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. 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, update_time`.
Location : query
Type : string
filter
Description : Optional. The filter field that the list request will filter on. Possible filters are described in https://google.aip.dev/160.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List pipelines.
▼ ▲ eventarc.projects.locations.pipelines.create
Path : v1/{+parent}/pipelines
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/pipelines
HTTP Method : POST
Parameters :
parent
Description : Required. The parent collection in which to add this pipeline.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pipelineId
Description : Required. The user-provided ID to be assigned to the Pipeline.
Location : query
Type : string
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a new Pipeline in a particular project and location.
▼ ▲ eventarc.projects.locations.pipelines.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/pipelines/{pipeline}` format.
Pattern : ^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. 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 "*".
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : Optional. If set to true, and the Pipeline is not found, a new Pipeline will be created. In this situation, `update_mask` is ignored.
Location : query
Type : boolean
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a single pipeline.
▼ ▲ eventarc.projects.locations.pipelines.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the Pipeline to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/pipelines/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource.
Location : query
Type : string
allowMissing
Description : Optional. If set to true, and the Pipeline is not found, the request will succeed but no action will be taken on the server.
Location : query
Type : boolean
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a single pipeline.
▼ ▲ eventarc.projects.locations.googleApiSources.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the google api source to get.
Pattern : ^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a single GoogleApiSource.
▼ ▲ eventarc.projects.locations.googleApiSources.list
Path : v1/{+parent}/googleApiSources
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/googleApiSources
HTTP Method : GET
Parameters :
parent
Description : Required. The parent collection to list GoogleApiSources on.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of results to return on each page. Note: The service may send fewer.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The page token; provide the value from the `next_page_token` field in a previous call to retrieve the subsequent page. When paginating, all other parameters provided must match the previous call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. 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, update_time`.
Location : query
Type : string
filter
Description : Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List GoogleApiSources.
▼ ▲ eventarc.projects.locations.googleApiSources.create
Path : v1/{+parent}/googleApiSources
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/googleApiSources
HTTP Method : POST
Parameters :
parent
Description : Required. The parent collection in which to add this google api source.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
googleApiSourceId
Description : Required. The user-provided ID to be assigned to the GoogleApiSource. It should match the format (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$).
Location : query
Type : string
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a new GoogleApiSource in a particular project and location.
▼ ▲ eventarc.projects.locations.googleApiSources.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
Pattern : ^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. 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 "*".
Location : query
Type : string
Format : google-fieldmask
allowMissing
Description : Optional. If set to true, and the GoogleApiSource is not found, a new GoogleApiSource will be created. In this situation, `update_mask` is ignored.
Location : query
Type : boolean
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a single GoogleApiSource.
▼ ▲ eventarc.projects.locations.googleApiSources.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the GoogleApiSource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/googleApiSources/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.
Location : query
Type : string
allowMissing
Description : Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.
Location : query
Type : boolean
validateOnly
Description : Optional. If set, validate the request and preview the review, but do not post it.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a single GoogleApiSource.