Google Cloud Eventarc V1 Client - Class MessageBus (2.1.0)

Version latest

• 2.1.0 (latest)
• 2.0.1
• 1.3.5
• 1.2.2
• 1.1.1
• 1.0.5

Reference documentation and code samples for the Google Cloud Eventarc V1 Client class 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.

Generated from protobuf message google.cloud.eventarc.v1.MessageBus

Namespace

Google \ Cloud \ Eventarc \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
↳ 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.
↳ 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.
↳ create_time	Google\Protobuf\Timestamp Output only. The creation time.
↳ update_time	Google\Protobuf\Timestamp Output only. The last-modified time.
↳ labels	array|Google\Protobuf\Internal\MapField Optional. Resource labels.
↳ annotations	array|Google\Protobuf\Internal\MapField Optional. Resource annotations.
↳ display_name	string Optional. Resource display name.
↳ crypto_key_name	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/*.
↳ logging_config	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.

getName

Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}

Returns
Type	Description
string

setName

Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUid

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.

Returns
Type	Description
string

setUid

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEtag

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.

Returns
Type	Description
string

setEtag

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. The creation time.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The last-modified time.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last-modified time.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

Optional. Resource labels.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Resource labels.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getAnnotations

Optional. Resource annotations.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setAnnotations

Optional. Resource annotations.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getDisplayName

Optional. Resource display name.

Returns
Type	Description
string

setDisplayName

Optional. Resource display name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCryptoKeyName

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
Type	Description
string

setCryptoKeyName

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/*.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLoggingConfig

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
Type	Description
Google\Cloud\Eventarc\V1\LoggingConfig|null

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

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.

Parameter
Name	Description
var	Google\Cloud\Eventarc\V1\LoggingConfig

Returns
Type	Description
$this