Reference documentation and code samples for the Cloud PubSub V1 Client class AzureEventHubs.
Ingestion settings for Azure Event Hubs.
Generated from protobuf message google.pubsub.v1.IngestionDataSourceSettings.AzureEventHubs
Namespace
Google \ Cloud \ PubSub \ V1 \ IngestionDataSourceSettingsMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ state |
int
Output only. An output-only field that indicates the state of the Event Hubs ingestion source. |
↳ resource_group |
string
Optional. Name of the resource group within the azure subscription. |
↳ namespace |
string
Optional. The name of the Event Hubs namespace. |
↳ event_hub |
string
Optional. The name of the Event Hub. |
↳ client_id |
string
Optional. The client id of the Azure application that is being used to authenticate Pub/Sub. |
↳ tenant_id |
string
Optional. The tenant id of the Azure application that is being used to authenticate Pub/Sub. |
↳ subscription_id |
string
Optional. The Azure subscription id. |
↳ gcp_service_account |
string
Optional. The GCP service account to be used for Federated Identity authentication. |
getState
Output only. An output-only field that indicates the state of the Event Hubs ingestion source.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. An output-only field that indicates the state of the Event Hubs ingestion source.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResourceGroup
Optional. Name of the resource group within the azure subscription.
| Returns | |
|---|---|
| Type | Description |
string |
|
setResourceGroup
Optional. Name of the resource group within the azure subscription.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNamespace
Optional. The name of the Event Hubs namespace.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNamespace
Optional. The name of the Event Hubs namespace.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventHub
Optional. The name of the Event Hub.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEventHub
Optional. The name of the Event Hub.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientId
Optional. The client id of the Azure application that is being used to authenticate Pub/Sub.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClientId
Optional. The client id of the Azure application that is being used to authenticate Pub/Sub.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTenantId
Optional. The tenant id of the Azure application that is being used to authenticate Pub/Sub.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTenantId
Optional. The tenant id of the Azure application that is being used to authenticate Pub/Sub.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubscriptionId
Optional. The Azure subscription id.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSubscriptionId
Optional. The Azure subscription id.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcpServiceAccount
Optional. The GCP service account to be used for Federated Identity authentication.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGcpServiceAccount
Optional. The GCP service account to be used for Federated Identity authentication.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|