Reference documentation and code samples for the Eventarc V1 API class Google::Cloud::Eventarc::V1::MessageBus.
MessageBus for the messages flowing through the system. The admin has
visibility and control over the messages being published and consumed and can
restrict publishers and subscribers to only a subset of data available in the
system by defining authorization policies.
(::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/*.
#crypto_key_name=
defcrypto_key_name=(value)->::String
Parameter
value (::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/*.
Returns
(::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/*.
#display_name
defdisplay_name()->::String
Returns
(::String) — Optional. Resource display name.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — Optional. Resource display name.
Returns
(::String) — Optional. Resource display name.
#etag
defetag()->::String
Returns
(::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.
(::Google::Cloud::Eventarc::V1::LoggingConfig) — 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.
value (::Google::Cloud::Eventarc::V1::LoggingConfig) — 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.
Returns
(::Google::Cloud::Eventarc::V1::LoggingConfig) — 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
defname()->::String
Returns
(::String) — Identifier. Resource name of the form
projects/{project}/locations/{location}/messageBuses/{message_bus}
#name=
defname=(value)->::String
Parameter
value (::String) — Identifier. Resource name of the form
projects/{project}/locations/{location}/messageBuses/{message_bus}
Returns
(::String) — Identifier. Resource name of the form
projects/{project}/locations/{location}/messageBuses/{message_bus}
#uid
defuid()->::String
Returns
(::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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Eventarc V1 API - Class Google::Cloud::Eventarc::V1::MessageBus (v2.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.0 (latest)](/ruby/docs/reference/google-cloud-eventarc-v1/latest/Google-Cloud-Eventarc-V1-MessageBus)\n- [2.0.1](/ruby/docs/reference/google-cloud-eventarc-v1/2.0.1/Google-Cloud-Eventarc-V1-MessageBus)\n- [1.3.0](/ruby/docs/reference/google-cloud-eventarc-v1/1.3.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [1.2.0](/ruby/docs/reference/google-cloud-eventarc-v1/1.2.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [1.1.0](/ruby/docs/reference/google-cloud-eventarc-v1/1.1.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [1.0.1](/ruby/docs/reference/google-cloud-eventarc-v1/1.0.1/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.10.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.10.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.9.2](/ruby/docs/reference/google-cloud-eventarc-v1/0.9.2/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.8.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.8.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.7.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.7.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.6.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.6.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.5.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.5.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.4.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.4.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.3.0](/ruby/docs/reference/google-cloud-eventarc-v1/0.3.0/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.2.1](/ruby/docs/reference/google-cloud-eventarc-v1/0.2.1/Google-Cloud-Eventarc-V1-MessageBus)\n- [0.1.4](/ruby/docs/reference/google-cloud-eventarc-v1/0.1.4/Google-Cloud-Eventarc-V1-MessageBus) \nReference documentation and code samples for the Eventarc V1 API class Google::Cloud::Eventarc::V1::MessageBus.\n\nMessageBus for the messages flowing through the system. The admin has\nvisibility and control over the messages being published and consumed and can\nrestrict publishers and subscribers to only a subset of data available in the\nsystem by defining authorization policies. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #annotations\n\n def annotations() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Resource annotations.\n\n### #annotations=\n\n def annotations=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Resource annotations. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Resource annotations.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The creation time.\n\n### #crypto_key_name\n\n def crypto_key_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.\n\n It must match the pattern\n `projects/*/locations/*/keyRings/*/cryptoKeys/*`.\n\n### #crypto_key_name=\n\n def crypto_key_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.\n\n\n It must match the pattern\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`. \n**Returns**\n\n- (::String) --- Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.\n\n It must match the pattern\n `projects/*/locations/*/keyRings/*/cryptoKeys/*`.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Resource display name.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Resource display name. \n**Returns**\n\n- (::String) --- Optional. Resource display name.\n\n### #etag\n\n def etag() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Resource labels.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Resource labels. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Resource labels.\n\n### #logging_config\n\n def logging_config() -\u003e ::Google::Cloud::Eventarc::V1::LoggingConfig\n\n**Returns**\n\n- ([::Google::Cloud::Eventarc::V1::LoggingConfig](./Google-Cloud-Eventarc-V1-LoggingConfig)) --- 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.\n\n### #logging_config=\n\n def logging_config=(value) -\u003e ::Google::Cloud::Eventarc::V1::LoggingConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Eventarc::V1::LoggingConfig](./Google-Cloud-Eventarc-V1-LoggingConfig)) --- 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. \n**Returns**\n\n- ([::Google::Cloud::Eventarc::V1::LoggingConfig](./Google-Cloud-Eventarc-V1-LoggingConfig)) --- 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.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus} \n**Returns**\n\n- (::String) --- Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}\n\n### #uid\n\n def uid() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The last-modified time."]]