Google Cloud Eventarc V1 Client - Class GoogleApiSource (2.1.3)

Reference documentation and code samples for the Google Cloud Eventarc V1 Client class GoogleApiSource.

A GoogleApiSource represents a subscription of 1P events from a MessageBus.

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

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}/googleApiSources/{google_api_source}
↳ 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.
↳ destination string

Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
↳ 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 LoggingConfig

Optional. Config to control Platform logging for the GoogleApiSource.

getName

Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}

Returns
Type Description
string

setName

Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}

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

getDestination

Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus.

Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)

Returns
Type Description
string

setDestination

Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus.

Format: "projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)

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 GoogleApiSource.

Returns
Type Description
LoggingConfig|null

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

Optional. Config to control Platform logging for the GoogleApiSource.

Parameter
Name Description
var LoggingConfig
Returns
Type Description
$this