Reference documentation and code samples for the Cloud PubSub V1 Client class ConfluentCloudFailureReason.
Failure when ingesting from a Confluent Cloud source.
Generated from protobuf message google.pubsub.v1.IngestionFailureEvent.ConfluentCloudFailureReason
Namespace
Google \ Cloud \ PubSub \ V1 \ IngestionFailureEventMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ cluster_id |
string
Optional. The cluster ID containing the topic being ingested from. |
↳ kafka_topic |
string
Optional. The name of the Kafka topic being ingested from. |
↳ partition_id |
int|string
Optional. The partition ID of the message that failed to be ingested. |
↳ offset |
int|string
Optional. The offset within the partition of the message that failed to be ingested. |
↳ api_violation_reason |
ApiViolationReason
Optional. The Pub/Sub API limits prevented the desired message from being published. |
↳ schema_violation_reason |
SchemaViolationReason
Optional. The Pub/Sub message failed schema validation. |
↳ message_transformation_failure_reason |
MessageTransformationFailureReason
Optional. Failure encountered when applying a message transformation to the Pub/Sub message. |
getClusterId
Optional. The cluster ID containing the topic being ingested from.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClusterId
Optional. The cluster ID containing the topic being ingested from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKafkaTopic
Optional. The name of the Kafka topic being ingested from.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKafkaTopic
Optional. The name of the Kafka topic being ingested from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPartitionId
Optional. The partition ID of the message that failed to be ingested.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setPartitionId
Optional. The partition ID of the message that failed to be ingested.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOffset
Optional. The offset within the partition of the message that failed to be ingested.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setOffset
Optional. The offset within the partition of the message that failed to be ingested.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApiViolationReason
Optional. The Pub/Sub API limits prevented the desired message from being published.
| Returns | |
|---|---|
| Type | Description |
ApiViolationReason|null |
|
hasApiViolationReason
setApiViolationReason
Optional. The Pub/Sub API limits prevented the desired message from being published.
| Parameter | |
|---|---|
| Name | Description |
var |
ApiViolationReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchemaViolationReason
Optional. The Pub/Sub message failed schema validation.
| Returns | |
|---|---|
| Type | Description |
SchemaViolationReason|null |
|
hasSchemaViolationReason
setSchemaViolationReason
Optional. The Pub/Sub message failed schema validation.
| Parameter | |
|---|---|
| Name | Description |
var |
SchemaViolationReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessageTransformationFailureReason
Optional. Failure encountered when applying a message transformation to the Pub/Sub message.
| Returns | |
|---|---|
| Type | Description |
MessageTransformationFailureReason|null |
|
hasMessageTransformationFailureReason
setMessageTransformationFailureReason
Optional. Failure encountered when applying a message transformation to the Pub/Sub message.
| Parameter | |
|---|---|
| Name | Description |
var |
MessageTransformationFailureReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReason
| Returns | |
|---|---|
| Type | Description |
string |
|