message_buses

Creates, updates, deletes, gets or lists a message_buses resource.

Overview

Name	message_buses
Type	Resource
Id	google.eventarc.message_buses

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
annotations	object	Optional. Resource annotations.
createTime	string (google-datetime)	Output only. The creation time.
cryptoKeyName	string	Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
displayName	string	Optional. Resource display name.
etag	string	Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
labels	object	Optional. Resource labels.
loggingConfig	object	Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it. (id: LoggingConfig)
uid	string	Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
updateTime	string (google-datetime)	Output only. The last-modified time.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
annotations	object	Optional. Resource annotations.
createTime	string (google-datetime)	Output only. The creation time.
cryptoKeyName	string	Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
displayName	string	Optional. Resource display name.
etag	string	Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
labels	object	Optional. Resource labels.
loggingConfig	object	Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it. (id: LoggingConfig)
uid	string	Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
updateTime	string (google-datetime)	Output only. The last-modified time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, messageBusesId		Get a single MessageBus.
list	select	projectsId, locationsId	pageSize, pageToken, orderBy, filter	List message buses.
create	insert	projectsId, locationsId	messageBusId, validateOnly	Create a new MessageBus in a particular project and location.
patch	update	projectsId, locationsId, messageBusesId	updateMask, allowMissing, validateOnly	Update a single message bus.
delete	delete	projectsId, locationsId, messageBusesId	etag, allowMissing, validateOnly	Delete a single message bus.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
messageBusesId	string
projectsId	string
allowMissing	boolean
etag	string
filter	string
messageBusId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Get a single MessageBus.

SELECT
name,
annotations,
createTime,
cryptoKeyName,
displayName,
etag,
labels,
loggingConfig,
uid,
updateTime
FROM google.eventarc.message_buses
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND messageBusesId = '{{ messageBusesId }}' -- required;

list

List message buses.

SELECT
name,
annotations,
createTime,
cryptoKeyName,
displayName,
etag,
labels,
loggingConfig,
uid,
updateTime
FROM google.eventarc.message_buses
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

INSERT examples

create

Create a new MessageBus in a particular project and location.

INSERT INTO google.eventarc.message_buses (
data__name,
data__labels,
data__annotations,
data__displayName,
data__cryptoKeyName,
data__loggingConfig,
projectsId,
locationsId,
messageBusId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ displayName }}',
'{{ cryptoKeyName }}',
'{{ loggingConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ messageBusId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: message_buses
  props:
    - name: projectsId
      value: string
      description: Required parameter for the message_buses resource.
    - name: locationsId
      value: string
      description: Required parameter for the message_buses resource.
    - name: name
      value: string
      description: >
        Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
        
    - name: labels
      value: object
      description: >
        Optional. Resource labels.
        
    - name: annotations
      value: object
      description: >
        Optional. Resource annotations.
        
    - name: displayName
      value: string
      description: >
        Optional. Resource display name.
        
    - name: cryptoKeyName
      value: string
      description: >
        Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
        
    - name: loggingConfig
      value: object
      description: >
        Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it.
        
    - name: messageBusId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Update a single message bus.

UPDATE google.eventarc.message_buses
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}',
data__displayName = '{{ displayName }}',
data__cryptoKeyName = '{{ cryptoKeyName }}',
data__loggingConfig = '{{ loggingConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND messageBusesId = '{{ messageBusesId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Delete a single message bus.

DELETE FROM google.eventarc.message_buses
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND messageBusesId = '{{ messageBusesId }}' --required
AND etag = '{{ etag }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}';