Class: Google::Cloud::PubSub::V1::IngestionDataSourceSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/pubsub/v1/pubsub.rb

Overview

Settings for an ingestion data source on a topic.

Defined Under Namespace

Classes: AwsKinesis, AwsMsk, AzureEventHubs, CloudStorage, ConfluentCloud

Instance Attribute Summary collapse

Instance Attribute Details

#aws_kinesis ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis

Returns Optional. Amazon Kinesis Data Streams.

Note: The following fields are mutually exclusive: aws_kinesis, cloud_storage, azure_event_hubs, aws_msk, confluent_cloud. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 100

class IngestionDataSourceSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Ingestion settings for Amazon Kinesis Data Streams.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis::State]
  #     Output only. An output-only field that indicates the state of the Kinesis
  #     ingestion source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Required. The Kinesis stream ARN to ingest data from.
  # @!attribute [rw] consumer_arn
  #   @return [::String]
  #     Required. The Kinesis consumer ARN to used for ingestion in Enhanced
  #     Fan-Out mode. The consumer must be already created and ready to be used.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Kinesis. Check the Pub/Sub docs for how to set up this role and the
  #     required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
  #     the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsKinesis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for ingestion from Amazon Kinesis Data Streams.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Kinesis.
      # This can happen if:
      #   - The provided `aws_role_arn` does not exist or does not have the
      #     appropriate permissions attached.
      #   - The provided `aws_role_arn` is not set up properly for Identity
      #     Federation using `gcp_service_account`.
      #   - The Pub/Sub SA is not granted the
      #     `iam.serviceAccounts.getOpenIdToken` permission on
      #     `gcp_service_account`.
      KINESIS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The Kinesis stream does not exist.
      STREAM_NOT_FOUND = 4

      # The Kinesis consumer does not exist.
      CONSUMER_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Cloud Storage.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::State]
  #     Output only. An output-only field that indicates the state of the Cloud
  #     Storage ingestion source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Cloud Storage bucket. The bucket name must be without any
  #     prefix like "gs://". See the [bucket naming requirements]
  #     (https://cloud.google.com/storage/docs/buckets#naming).
  # @!attribute [rw] text_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::TextFormat]
  #     Optional. Data from Cloud Storage will be interpreted as text.
  #
  #     Note: The following fields are mutually exclusive: `text_format`, `avro_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  #
  #     Note: The following fields are mutually exclusive: `avro_format`, `text_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] pubsub_avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::PubSubAvroFormat]
  #     Optional. It will be assumed data from Cloud Storage was written via
  #     [Cloud Storage
  #     subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
  #
  #     Note: The following fields are mutually exclusive: `pubsub_avro_format`, `text_format`, `avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] minimum_object_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. Only objects with a larger or equal creation timestamp will be
  #     ingested.
  # @!attribute [rw] match_glob
  #   @return [::String]
  #     Optional. Glob pattern used to match objects that will be ingested. If
  #     unset, all objects will be ingested. See the [supported
  #     patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
  class CloudStorage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration for reading Cloud Storage data in text format. Each line of
    # text as specified by the delimiter will be set to the `data` field of a
    # Pub/Sub message.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. When unset, '\n' is used.
    class TextFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data in Avro binary format. The
    # bytes of each object will be set to the `data` field of a Pub/Sub
    # message.
    class AvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data written via [Cloud Storage
    # subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The
    # data and attributes fields of the originally exported Pub/Sub message
    # will be restored when publishing.
    class PubSubAvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Possible states for ingestion from Cloud Storage.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while calling the Cloud Storage API. This
      # can happen if the Pub/Sub SA has not been granted the
      # [appropriate
      # permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions):
      # - storage.objects.list: to list the objects in a bucket.
      # - storage.objects.get: to read the objects in a bucket.
      # - storage.buckets.get: to verify the bucket exists.
      CLOUD_STORAGE_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Cloud Storage bucket doesn't exist.
      BUCKET_NOT_FOUND = 4

      # The Cloud Storage bucket has too many objects, ingestion will be
      # paused.
      TOO_MANY_OBJECTS = 5
    end
  end

  # Ingestion settings for Azure Event Hubs.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AzureEventHubs::State]
  #     Output only. An output-only field that indicates the state of the Event
  #     Hubs ingestion source.
  # @!attribute [rw] resource_group
  #   @return [::String]
  #     Optional. Name of the resource group within the azure subscription.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The name of the Event Hubs namespace.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the Event Hub.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Optional. The client id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Optional. The tenant id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] subscription_id
  #   @return [::String]
  #     Optional. The Azure subscription id.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Optional. The GCP service account to be used for Federated Identity
  #     authentication.
  class AzureEventHubs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Event Hubs.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Event Hubs.
      # This can happen when `client_id`, or `tenant_id` are invalid. Or the
      # right permissions haven't been granted.
      EVENT_HUBS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Event Hubs namespace couldn't be found.
      NAMESPACE_NOT_FOUND = 4

      # The provided Event Hub couldn't be found.
      EVENT_HUB_NOT_FOUND = 5

      # The provided Event Hubs subscription couldn't be found.
      SUBSCRIPTION_NOT_FOUND = 6

      # The provided Event Hubs resource group couldn't be found.
      RESOURCE_GROUP_NOT_FOUND = 7
    end
  end

  # Ingestion settings for Amazon MSK.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State]
  #     Output only. An output-only field that indicates the state of the Amazon
  #     MSK ingestion source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Required. The Amazon Resource Name (ARN) that uniquely identifies the
  #     cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Amazon MSK cluster that Pub/Sub
  #     will import from.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Amazon MSK. Check the Pub/Sub docs for how to set up this role and
  #     the required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call
  #     for the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsMsk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Amazon MSK.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Amazon MSK.
      MSK_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided MSK cluster wasn't found.
      CLUSTER_NOT_FOUND = 4

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Confluent Cloud.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::ConfluentCloud::State]
  #     Output only. An output-only field that indicates the state of the
  #     Confluent Cloud ingestion source.
  # @!attribute [rw] bootstrap_server
  #   @return [::String]
  #     Required. The address of the bootstrap server. The format is url:port.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Required. The id of the cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Confluent Cloud cluster that
  #     Pub/Sub will import from.
  # @!attribute [rw] identity_pool_id
  #   @return [::String]
  #     Required. The id of the identity pool to be used for Federated Identity
  #     authentication with Confluent Cloud. See
  #     https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with `identity_pool_id`.
  class ConfluentCloud
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Confluent Cloud.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Confluent
      # Cloud.
      CONFLUENT_CLOUD_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided bootstrap server address is unreachable.
      UNREACHABLE_BOOTSTRAP_SERVER = 4

      # The provided cluster wasn't found.
      CLUSTER_NOT_FOUND = 5

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 6
    end
  end
end

#aws_msk ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk

Returns Optional. Amazon MSK.

Note: The following fields are mutually exclusive: aws_msk, aws_kinesis, cloud_storage, azure_event_hubs, confluent_cloud. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 100

class IngestionDataSourceSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Ingestion settings for Amazon Kinesis Data Streams.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis::State]
  #     Output only. An output-only field that indicates the state of the Kinesis
  #     ingestion source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Required. The Kinesis stream ARN to ingest data from.
  # @!attribute [rw] consumer_arn
  #   @return [::String]
  #     Required. The Kinesis consumer ARN to used for ingestion in Enhanced
  #     Fan-Out mode. The consumer must be already created and ready to be used.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Kinesis. Check the Pub/Sub docs for how to set up this role and the
  #     required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
  #     the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsKinesis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for ingestion from Amazon Kinesis Data Streams.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Kinesis.
      # This can happen if:
      #   - The provided `aws_role_arn` does not exist or does not have the
      #     appropriate permissions attached.
      #   - The provided `aws_role_arn` is not set up properly for Identity
      #     Federation using `gcp_service_account`.
      #   - The Pub/Sub SA is not granted the
      #     `iam.serviceAccounts.getOpenIdToken` permission on
      #     `gcp_service_account`.
      KINESIS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The Kinesis stream does not exist.
      STREAM_NOT_FOUND = 4

      # The Kinesis consumer does not exist.
      CONSUMER_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Cloud Storage.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::State]
  #     Output only. An output-only field that indicates the state of the Cloud
  #     Storage ingestion source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Cloud Storage bucket. The bucket name must be without any
  #     prefix like "gs://". See the [bucket naming requirements]
  #     (https://cloud.google.com/storage/docs/buckets#naming).
  # @!attribute [rw] text_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::TextFormat]
  #     Optional. Data from Cloud Storage will be interpreted as text.
  #
  #     Note: The following fields are mutually exclusive: `text_format`, `avro_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  #
  #     Note: The following fields are mutually exclusive: `avro_format`, `text_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] pubsub_avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::PubSubAvroFormat]
  #     Optional. It will be assumed data from Cloud Storage was written via
  #     [Cloud Storage
  #     subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
  #
  #     Note: The following fields are mutually exclusive: `pubsub_avro_format`, `text_format`, `avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] minimum_object_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. Only objects with a larger or equal creation timestamp will be
  #     ingested.
  # @!attribute [rw] match_glob
  #   @return [::String]
  #     Optional. Glob pattern used to match objects that will be ingested. If
  #     unset, all objects will be ingested. See the [supported
  #     patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
  class CloudStorage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration for reading Cloud Storage data in text format. Each line of
    # text as specified by the delimiter will be set to the `data` field of a
    # Pub/Sub message.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. When unset, '\n' is used.
    class TextFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data in Avro binary format. The
    # bytes of each object will be set to the `data` field of a Pub/Sub
    # message.
    class AvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data written via [Cloud Storage
    # subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The
    # data and attributes fields of the originally exported Pub/Sub message
    # will be restored when publishing.
    class PubSubAvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Possible states for ingestion from Cloud Storage.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while calling the Cloud Storage API. This
      # can happen if the Pub/Sub SA has not been granted the
      # [appropriate
      # permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions):
      # - storage.objects.list: to list the objects in a bucket.
      # - storage.objects.get: to read the objects in a bucket.
      # - storage.buckets.get: to verify the bucket exists.
      CLOUD_STORAGE_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Cloud Storage bucket doesn't exist.
      BUCKET_NOT_FOUND = 4

      # The Cloud Storage bucket has too many objects, ingestion will be
      # paused.
      TOO_MANY_OBJECTS = 5
    end
  end

  # Ingestion settings for Azure Event Hubs.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AzureEventHubs::State]
  #     Output only. An output-only field that indicates the state of the Event
  #     Hubs ingestion source.
  # @!attribute [rw] resource_group
  #   @return [::String]
  #     Optional. Name of the resource group within the azure subscription.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The name of the Event Hubs namespace.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the Event Hub.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Optional. The client id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Optional. The tenant id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] subscription_id
  #   @return [::String]
  #     Optional. The Azure subscription id.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Optional. The GCP service account to be used for Federated Identity
  #     authentication.
  class AzureEventHubs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Event Hubs.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Event Hubs.
      # This can happen when `client_id`, or `tenant_id` are invalid. Or the
      # right permissions haven't been granted.
      EVENT_HUBS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Event Hubs namespace couldn't be found.
      NAMESPACE_NOT_FOUND = 4

      # The provided Event Hub couldn't be found.
      EVENT_HUB_NOT_FOUND = 5

      # The provided Event Hubs subscription couldn't be found.
      SUBSCRIPTION_NOT_FOUND = 6

      # The provided Event Hubs resource group couldn't be found.
      RESOURCE_GROUP_NOT_FOUND = 7
    end
  end

  # Ingestion settings for Amazon MSK.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State]
  #     Output only. An output-only field that indicates the state of the Amazon
  #     MSK ingestion source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Required. The Amazon Resource Name (ARN) that uniquely identifies the
  #     cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Amazon MSK cluster that Pub/Sub
  #     will import from.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Amazon MSK. Check the Pub/Sub docs for how to set up this role and
  #     the required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call
  #     for the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsMsk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Amazon MSK.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Amazon MSK.
      MSK_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided MSK cluster wasn't found.
      CLUSTER_NOT_FOUND = 4

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Confluent Cloud.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::ConfluentCloud::State]
  #     Output only. An output-only field that indicates the state of the
  #     Confluent Cloud ingestion source.
  # @!attribute [rw] bootstrap_server
  #   @return [::String]
  #     Required. The address of the bootstrap server. The format is url:port.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Required. The id of the cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Confluent Cloud cluster that
  #     Pub/Sub will import from.
  # @!attribute [rw] identity_pool_id
  #   @return [::String]
  #     Required. The id of the identity pool to be used for Federated Identity
  #     authentication with Confluent Cloud. See
  #     https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with `identity_pool_id`.
  class ConfluentCloud
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Confluent Cloud.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Confluent
      # Cloud.
      CONFLUENT_CLOUD_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided bootstrap server address is unreachable.
      UNREACHABLE_BOOTSTRAP_SERVER = 4

      # The provided cluster wasn't found.
      CLUSTER_NOT_FOUND = 5

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 6
    end
  end
end

#azure_event_hubs ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AzureEventHubs

Returns Optional. Azure Event Hubs.

Note: The following fields are mutually exclusive: azure_event_hubs, aws_kinesis, cloud_storage, aws_msk, confluent_cloud. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 100

class IngestionDataSourceSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Ingestion settings for Amazon Kinesis Data Streams.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis::State]
  #     Output only. An output-only field that indicates the state of the Kinesis
  #     ingestion source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Required. The Kinesis stream ARN to ingest data from.
  # @!attribute [rw] consumer_arn
  #   @return [::String]
  #     Required. The Kinesis consumer ARN to used for ingestion in Enhanced
  #     Fan-Out mode. The consumer must be already created and ready to be used.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Kinesis. Check the Pub/Sub docs for how to set up this role and the
  #     required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
  #     the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsKinesis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for ingestion from Amazon Kinesis Data Streams.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Kinesis.
      # This can happen if:
      #   - The provided `aws_role_arn` does not exist or does not have the
      #     appropriate permissions attached.
      #   - The provided `aws_role_arn` is not set up properly for Identity
      #     Federation using `gcp_service_account`.
      #   - The Pub/Sub SA is not granted the
      #     `iam.serviceAccounts.getOpenIdToken` permission on
      #     `gcp_service_account`.
      KINESIS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The Kinesis stream does not exist.
      STREAM_NOT_FOUND = 4

      # The Kinesis consumer does not exist.
      CONSUMER_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Cloud Storage.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::State]
  #     Output only. An output-only field that indicates the state of the Cloud
  #     Storage ingestion source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Cloud Storage bucket. The bucket name must be without any
  #     prefix like "gs://". See the [bucket naming requirements]
  #     (https://cloud.google.com/storage/docs/buckets#naming).
  # @!attribute [rw] text_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::TextFormat]
  #     Optional. Data from Cloud Storage will be interpreted as text.
  #
  #     Note: The following fields are mutually exclusive: `text_format`, `avro_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  #
  #     Note: The following fields are mutually exclusive: `avro_format`, `text_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] pubsub_avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::PubSubAvroFormat]
  #     Optional. It will be assumed data from Cloud Storage was written via
  #     [Cloud Storage
  #     subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
  #
  #     Note: The following fields are mutually exclusive: `pubsub_avro_format`, `text_format`, `avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] minimum_object_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. Only objects with a larger or equal creation timestamp will be
  #     ingested.
  # @!attribute [rw] match_glob
  #   @return [::String]
  #     Optional. Glob pattern used to match objects that will be ingested. If
  #     unset, all objects will be ingested. See the [supported
  #     patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
  class CloudStorage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration for reading Cloud Storage data in text format. Each line of
    # text as specified by the delimiter will be set to the `data` field of a
    # Pub/Sub message.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. When unset, '\n' is used.
    class TextFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data in Avro binary format. The
    # bytes of each object will be set to the `data` field of a Pub/Sub
    # message.
    class AvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data written via [Cloud Storage
    # subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The
    # data and attributes fields of the originally exported Pub/Sub message
    # will be restored when publishing.
    class PubSubAvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Possible states for ingestion from Cloud Storage.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while calling the Cloud Storage API. This
      # can happen if the Pub/Sub SA has not been granted the
      # [appropriate
      # permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions):
      # - storage.objects.list: to list the objects in a bucket.
      # - storage.objects.get: to read the objects in a bucket.
      # - storage.buckets.get: to verify the bucket exists.
      CLOUD_STORAGE_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Cloud Storage bucket doesn't exist.
      BUCKET_NOT_FOUND = 4

      # The Cloud Storage bucket has too many objects, ingestion will be
      # paused.
      TOO_MANY_OBJECTS = 5
    end
  end

  # Ingestion settings for Azure Event Hubs.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AzureEventHubs::State]
  #     Output only. An output-only field that indicates the state of the Event
  #     Hubs ingestion source.
  # @!attribute [rw] resource_group
  #   @return [::String]
  #     Optional. Name of the resource group within the azure subscription.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The name of the Event Hubs namespace.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the Event Hub.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Optional. The client id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Optional. The tenant id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] subscription_id
  #   @return [::String]
  #     Optional. The Azure subscription id.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Optional. The GCP service account to be used for Federated Identity
  #     authentication.
  class AzureEventHubs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Event Hubs.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Event Hubs.
      # This can happen when `client_id`, or `tenant_id` are invalid. Or the
      # right permissions haven't been granted.
      EVENT_HUBS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Event Hubs namespace couldn't be found.
      NAMESPACE_NOT_FOUND = 4

      # The provided Event Hub couldn't be found.
      EVENT_HUB_NOT_FOUND = 5

      # The provided Event Hubs subscription couldn't be found.
      SUBSCRIPTION_NOT_FOUND = 6

      # The provided Event Hubs resource group couldn't be found.
      RESOURCE_GROUP_NOT_FOUND = 7
    end
  end

  # Ingestion settings for Amazon MSK.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State]
  #     Output only. An output-only field that indicates the state of the Amazon
  #     MSK ingestion source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Required. The Amazon Resource Name (ARN) that uniquely identifies the
  #     cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Amazon MSK cluster that Pub/Sub
  #     will import from.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Amazon MSK. Check the Pub/Sub docs for how to set up this role and
  #     the required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call
  #     for the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsMsk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Amazon MSK.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Amazon MSK.
      MSK_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided MSK cluster wasn't found.
      CLUSTER_NOT_FOUND = 4

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Confluent Cloud.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::ConfluentCloud::State]
  #     Output only. An output-only field that indicates the state of the
  #     Confluent Cloud ingestion source.
  # @!attribute [rw] bootstrap_server
  #   @return [::String]
  #     Required. The address of the bootstrap server. The format is url:port.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Required. The id of the cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Confluent Cloud cluster that
  #     Pub/Sub will import from.
  # @!attribute [rw] identity_pool_id
  #   @return [::String]
  #     Required. The id of the identity pool to be used for Federated Identity
  #     authentication with Confluent Cloud. See
  #     https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with `identity_pool_id`.
  class ConfluentCloud
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Confluent Cloud.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Confluent
      # Cloud.
      CONFLUENT_CLOUD_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided bootstrap server address is unreachable.
      UNREACHABLE_BOOTSTRAP_SERVER = 4

      # The provided cluster wasn't found.
      CLUSTER_NOT_FOUND = 5

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 6
    end
  end
end

#cloud_storage ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage

Returns Optional. Cloud Storage.

Note: The following fields are mutually exclusive: cloud_storage, aws_kinesis, azure_event_hubs, aws_msk, confluent_cloud. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 100

class IngestionDataSourceSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Ingestion settings for Amazon Kinesis Data Streams.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis::State]
  #     Output only. An output-only field that indicates the state of the Kinesis
  #     ingestion source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Required. The Kinesis stream ARN to ingest data from.
  # @!attribute [rw] consumer_arn
  #   @return [::String]
  #     Required. The Kinesis consumer ARN to used for ingestion in Enhanced
  #     Fan-Out mode. The consumer must be already created and ready to be used.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Kinesis. Check the Pub/Sub docs for how to set up this role and the
  #     required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
  #     the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsKinesis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for ingestion from Amazon Kinesis Data Streams.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Kinesis.
      # This can happen if:
      #   - The provided `aws_role_arn` does not exist or does not have the
      #     appropriate permissions attached.
      #   - The provided `aws_role_arn` is not set up properly for Identity
      #     Federation using `gcp_service_account`.
      #   - The Pub/Sub SA is not granted the
      #     `iam.serviceAccounts.getOpenIdToken` permission on
      #     `gcp_service_account`.
      KINESIS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The Kinesis stream does not exist.
      STREAM_NOT_FOUND = 4

      # The Kinesis consumer does not exist.
      CONSUMER_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Cloud Storage.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::State]
  #     Output only. An output-only field that indicates the state of the Cloud
  #     Storage ingestion source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Cloud Storage bucket. The bucket name must be without any
  #     prefix like "gs://". See the [bucket naming requirements]
  #     (https://cloud.google.com/storage/docs/buckets#naming).
  # @!attribute [rw] text_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::TextFormat]
  #     Optional. Data from Cloud Storage will be interpreted as text.
  #
  #     Note: The following fields are mutually exclusive: `text_format`, `avro_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  #
  #     Note: The following fields are mutually exclusive: `avro_format`, `text_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] pubsub_avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::PubSubAvroFormat]
  #     Optional. It will be assumed data from Cloud Storage was written via
  #     [Cloud Storage
  #     subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
  #
  #     Note: The following fields are mutually exclusive: `pubsub_avro_format`, `text_format`, `avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] minimum_object_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. Only objects with a larger or equal creation timestamp will be
  #     ingested.
  # @!attribute [rw] match_glob
  #   @return [::String]
  #     Optional. Glob pattern used to match objects that will be ingested. If
  #     unset, all objects will be ingested. See the [supported
  #     patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
  class CloudStorage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration for reading Cloud Storage data in text format. Each line of
    # text as specified by the delimiter will be set to the `data` field of a
    # Pub/Sub message.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. When unset, '\n' is used.
    class TextFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data in Avro binary format. The
    # bytes of each object will be set to the `data` field of a Pub/Sub
    # message.
    class AvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data written via [Cloud Storage
    # subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The
    # data and attributes fields of the originally exported Pub/Sub message
    # will be restored when publishing.
    class PubSubAvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Possible states for ingestion from Cloud Storage.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while calling the Cloud Storage API. This
      # can happen if the Pub/Sub SA has not been granted the
      # [appropriate
      # permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions):
      # - storage.objects.list: to list the objects in a bucket.
      # - storage.objects.get: to read the objects in a bucket.
      # - storage.buckets.get: to verify the bucket exists.
      CLOUD_STORAGE_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Cloud Storage bucket doesn't exist.
      BUCKET_NOT_FOUND = 4

      # The Cloud Storage bucket has too many objects, ingestion will be
      # paused.
      TOO_MANY_OBJECTS = 5
    end
  end

  # Ingestion settings for Azure Event Hubs.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AzureEventHubs::State]
  #     Output only. An output-only field that indicates the state of the Event
  #     Hubs ingestion source.
  # @!attribute [rw] resource_group
  #   @return [::String]
  #     Optional. Name of the resource group within the azure subscription.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The name of the Event Hubs namespace.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the Event Hub.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Optional. The client id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Optional. The tenant id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] subscription_id
  #   @return [::String]
  #     Optional. The Azure subscription id.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Optional. The GCP service account to be used for Federated Identity
  #     authentication.
  class AzureEventHubs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Event Hubs.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Event Hubs.
      # This can happen when `client_id`, or `tenant_id` are invalid. Or the
      # right permissions haven't been granted.
      EVENT_HUBS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Event Hubs namespace couldn't be found.
      NAMESPACE_NOT_FOUND = 4

      # The provided Event Hub couldn't be found.
      EVENT_HUB_NOT_FOUND = 5

      # The provided Event Hubs subscription couldn't be found.
      SUBSCRIPTION_NOT_FOUND = 6

      # The provided Event Hubs resource group couldn't be found.
      RESOURCE_GROUP_NOT_FOUND = 7
    end
  end

  # Ingestion settings for Amazon MSK.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State]
  #     Output only. An output-only field that indicates the state of the Amazon
  #     MSK ingestion source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Required. The Amazon Resource Name (ARN) that uniquely identifies the
  #     cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Amazon MSK cluster that Pub/Sub
  #     will import from.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Amazon MSK. Check the Pub/Sub docs for how to set up this role and
  #     the required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call
  #     for the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsMsk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Amazon MSK.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Amazon MSK.
      MSK_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided MSK cluster wasn't found.
      CLUSTER_NOT_FOUND = 4

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Confluent Cloud.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::ConfluentCloud::State]
  #     Output only. An output-only field that indicates the state of the
  #     Confluent Cloud ingestion source.
  # @!attribute [rw] bootstrap_server
  #   @return [::String]
  #     Required. The address of the bootstrap server. The format is url:port.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Required. The id of the cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Confluent Cloud cluster that
  #     Pub/Sub will import from.
  # @!attribute [rw] identity_pool_id
  #   @return [::String]
  #     Required. The id of the identity pool to be used for Federated Identity
  #     authentication with Confluent Cloud. See
  #     https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with `identity_pool_id`.
  class ConfluentCloud
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Confluent Cloud.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Confluent
      # Cloud.
      CONFLUENT_CLOUD_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided bootstrap server address is unreachable.
      UNREACHABLE_BOOTSTRAP_SERVER = 4

      # The provided cluster wasn't found.
      CLUSTER_NOT_FOUND = 5

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 6
    end
  end
end

#confluent_cloud ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::ConfluentCloud

Returns Optional. Confluent Cloud.

Note: The following fields are mutually exclusive: confluent_cloud, aws_kinesis, cloud_storage, azure_event_hubs, aws_msk. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 100

class IngestionDataSourceSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Ingestion settings for Amazon Kinesis Data Streams.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis::State]
  #     Output only. An output-only field that indicates the state of the Kinesis
  #     ingestion source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Required. The Kinesis stream ARN to ingest data from.
  # @!attribute [rw] consumer_arn
  #   @return [::String]
  #     Required. The Kinesis consumer ARN to used for ingestion in Enhanced
  #     Fan-Out mode. The consumer must be already created and ready to be used.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Kinesis. Check the Pub/Sub docs for how to set up this role and the
  #     required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
  #     the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsKinesis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for ingestion from Amazon Kinesis Data Streams.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Kinesis.
      # This can happen if:
      #   - The provided `aws_role_arn` does not exist or does not have the
      #     appropriate permissions attached.
      #   - The provided `aws_role_arn` is not set up properly for Identity
      #     Federation using `gcp_service_account`.
      #   - The Pub/Sub SA is not granted the
      #     `iam.serviceAccounts.getOpenIdToken` permission on
      #     `gcp_service_account`.
      KINESIS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The Kinesis stream does not exist.
      STREAM_NOT_FOUND = 4

      # The Kinesis consumer does not exist.
      CONSUMER_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Cloud Storage.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::State]
  #     Output only. An output-only field that indicates the state of the Cloud
  #     Storage ingestion source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Cloud Storage bucket. The bucket name must be without any
  #     prefix like "gs://". See the [bucket naming requirements]
  #     (https://cloud.google.com/storage/docs/buckets#naming).
  # @!attribute [rw] text_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::TextFormat]
  #     Optional. Data from Cloud Storage will be interpreted as text.
  #
  #     Note: The following fields are mutually exclusive: `text_format`, `avro_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  #
  #     Note: The following fields are mutually exclusive: `avro_format`, `text_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] pubsub_avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::PubSubAvroFormat]
  #     Optional. It will be assumed data from Cloud Storage was written via
  #     [Cloud Storage
  #     subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
  #
  #     Note: The following fields are mutually exclusive: `pubsub_avro_format`, `text_format`, `avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] minimum_object_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. Only objects with a larger or equal creation timestamp will be
  #     ingested.
  # @!attribute [rw] match_glob
  #   @return [::String]
  #     Optional. Glob pattern used to match objects that will be ingested. If
  #     unset, all objects will be ingested. See the [supported
  #     patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
  class CloudStorage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration for reading Cloud Storage data in text format. Each line of
    # text as specified by the delimiter will be set to the `data` field of a
    # Pub/Sub message.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. When unset, '\n' is used.
    class TextFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data in Avro binary format. The
    # bytes of each object will be set to the `data` field of a Pub/Sub
    # message.
    class AvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data written via [Cloud Storage
    # subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The
    # data and attributes fields of the originally exported Pub/Sub message
    # will be restored when publishing.
    class PubSubAvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Possible states for ingestion from Cloud Storage.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while calling the Cloud Storage API. This
      # can happen if the Pub/Sub SA has not been granted the
      # [appropriate
      # permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions):
      # - storage.objects.list: to list the objects in a bucket.
      # - storage.objects.get: to read the objects in a bucket.
      # - storage.buckets.get: to verify the bucket exists.
      CLOUD_STORAGE_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Cloud Storage bucket doesn't exist.
      BUCKET_NOT_FOUND = 4

      # The Cloud Storage bucket has too many objects, ingestion will be
      # paused.
      TOO_MANY_OBJECTS = 5
    end
  end

  # Ingestion settings for Azure Event Hubs.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AzureEventHubs::State]
  #     Output only. An output-only field that indicates the state of the Event
  #     Hubs ingestion source.
  # @!attribute [rw] resource_group
  #   @return [::String]
  #     Optional. Name of the resource group within the azure subscription.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The name of the Event Hubs namespace.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the Event Hub.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Optional. The client id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Optional. The tenant id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] subscription_id
  #   @return [::String]
  #     Optional. The Azure subscription id.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Optional. The GCP service account to be used for Federated Identity
  #     authentication.
  class AzureEventHubs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Event Hubs.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Event Hubs.
      # This can happen when `client_id`, or `tenant_id` are invalid. Or the
      # right permissions haven't been granted.
      EVENT_HUBS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Event Hubs namespace couldn't be found.
      NAMESPACE_NOT_FOUND = 4

      # The provided Event Hub couldn't be found.
      EVENT_HUB_NOT_FOUND = 5

      # The provided Event Hubs subscription couldn't be found.
      SUBSCRIPTION_NOT_FOUND = 6

      # The provided Event Hubs resource group couldn't be found.
      RESOURCE_GROUP_NOT_FOUND = 7
    end
  end

  # Ingestion settings for Amazon MSK.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State]
  #     Output only. An output-only field that indicates the state of the Amazon
  #     MSK ingestion source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Required. The Amazon Resource Name (ARN) that uniquely identifies the
  #     cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Amazon MSK cluster that Pub/Sub
  #     will import from.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Amazon MSK. Check the Pub/Sub docs for how to set up this role and
  #     the required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call
  #     for the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsMsk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Amazon MSK.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Amazon MSK.
      MSK_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided MSK cluster wasn't found.
      CLUSTER_NOT_FOUND = 4

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Confluent Cloud.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::ConfluentCloud::State]
  #     Output only. An output-only field that indicates the state of the
  #     Confluent Cloud ingestion source.
  # @!attribute [rw] bootstrap_server
  #   @return [::String]
  #     Required. The address of the bootstrap server. The format is url:port.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Required. The id of the cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Confluent Cloud cluster that
  #     Pub/Sub will import from.
  # @!attribute [rw] identity_pool_id
  #   @return [::String]
  #     Required. The id of the identity pool to be used for Federated Identity
  #     authentication with Confluent Cloud. See
  #     https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with `identity_pool_id`.
  class ConfluentCloud
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Confluent Cloud.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Confluent
      # Cloud.
      CONFLUENT_CLOUD_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided bootstrap server address is unreachable.
      UNREACHABLE_BOOTSTRAP_SERVER = 4

      # The provided cluster wasn't found.
      CLUSTER_NOT_FOUND = 5

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 6
    end
  end
end

#platform_logs_settings ⇒ ::Google::Cloud::PubSub::V1::PlatformLogsSettings

Returns Optional. Platform Logs settings. If unset, no Platform Logs will be generated.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 100

class IngestionDataSourceSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Ingestion settings for Amazon Kinesis Data Streams.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsKinesis::State]
  #     Output only. An output-only field that indicates the state of the Kinesis
  #     ingestion source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Required. The Kinesis stream ARN to ingest data from.
  # @!attribute [rw] consumer_arn
  #   @return [::String]
  #     Required. The Kinesis consumer ARN to used for ingestion in Enhanced
  #     Fan-Out mode. The consumer must be already created and ready to be used.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Kinesis. Check the Pub/Sub docs for how to set up this role and the
  #     required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
  #     the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsKinesis
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for ingestion from Amazon Kinesis Data Streams.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Kinesis.
      # This can happen if:
      #   - The provided `aws_role_arn` does not exist or does not have the
      #     appropriate permissions attached.
      #   - The provided `aws_role_arn` is not set up properly for Identity
      #     Federation using `gcp_service_account`.
      #   - The Pub/Sub SA is not granted the
      #     `iam.serviceAccounts.getOpenIdToken` permission on
      #     `gcp_service_account`.
      KINESIS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The Kinesis stream does not exist.
      STREAM_NOT_FOUND = 4

      # The Kinesis consumer does not exist.
      CONSUMER_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Cloud Storage.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::State]
  #     Output only. An output-only field that indicates the state of the Cloud
  #     Storage ingestion source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Cloud Storage bucket. The bucket name must be without any
  #     prefix like "gs://". See the [bucket naming requirements]
  #     (https://cloud.google.com/storage/docs/buckets#naming).
  # @!attribute [rw] text_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::TextFormat]
  #     Optional. Data from Cloud Storage will be interpreted as text.
  #
  #     Note: The following fields are mutually exclusive: `text_format`, `avro_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  #
  #     Note: The following fields are mutually exclusive: `avro_format`, `text_format`, `pubsub_avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] pubsub_avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::PubSubAvroFormat]
  #     Optional. It will be assumed data from Cloud Storage was written via
  #     [Cloud Storage
  #     subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
  #
  #     Note: The following fields are mutually exclusive: `pubsub_avro_format`, `text_format`, `avro_format`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] minimum_object_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. Only objects with a larger or equal creation timestamp will be
  #     ingested.
  # @!attribute [rw] match_glob
  #   @return [::String]
  #     Optional. Glob pattern used to match objects that will be ingested. If
  #     unset, all objects will be ingested. See the [supported
  #     patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
  class CloudStorage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration for reading Cloud Storage data in text format. Each line of
    # text as specified by the delimiter will be set to the `data` field of a
    # Pub/Sub message.
    # @!attribute [rw] delimiter
    #   @return [::String]
    #     Optional. When unset, '\n' is used.
    class TextFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data in Avro binary format. The
    # bytes of each object will be set to the `data` field of a Pub/Sub
    # message.
    class AvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration for reading Cloud Storage data written via [Cloud Storage
    # subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The
    # data and attributes fields of the originally exported Pub/Sub message
    # will be restored when publishing.
    class PubSubAvroFormat
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Possible states for ingestion from Cloud Storage.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while calling the Cloud Storage API. This
      # can happen if the Pub/Sub SA has not been granted the
      # [appropriate
      # permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions):
      # - storage.objects.list: to list the objects in a bucket.
      # - storage.objects.get: to read the objects in a bucket.
      # - storage.buckets.get: to verify the bucket exists.
      CLOUD_STORAGE_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic. This can
      # happen if the Pub/Sub SA has not been granted the [appropriate publish
      # permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Cloud Storage bucket doesn't exist.
      BUCKET_NOT_FOUND = 4

      # The Cloud Storage bucket has too many objects, ingestion will be
      # paused.
      TOO_MANY_OBJECTS = 5
    end
  end

  # Ingestion settings for Azure Event Hubs.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AzureEventHubs::State]
  #     Output only. An output-only field that indicates the state of the Event
  #     Hubs ingestion source.
  # @!attribute [rw] resource_group
  #   @return [::String]
  #     Optional. Name of the resource group within the azure subscription.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The name of the Event Hubs namespace.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the Event Hub.
  # @!attribute [rw] client_id
  #   @return [::String]
  #     Optional. The client id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] tenant_id
  #   @return [::String]
  #     Optional. The tenant id of the Azure application that is being used to
  #     authenticate Pub/Sub.
  # @!attribute [rw] subscription_id
  #   @return [::String]
  #     Optional. The Azure subscription id.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Optional. The GCP service account to be used for Federated Identity
  #     authentication.
  class AzureEventHubs
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Event Hubs.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Event Hubs.
      # This can happen when `client_id`, or `tenant_id` are invalid. Or the
      # right permissions haven't been granted.
      EVENT_HUBS_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided Event Hubs namespace couldn't be found.
      NAMESPACE_NOT_FOUND = 4

      # The provided Event Hub couldn't be found.
      EVENT_HUB_NOT_FOUND = 5

      # The provided Event Hubs subscription couldn't be found.
      SUBSCRIPTION_NOT_FOUND = 6

      # The provided Event Hubs resource group couldn't be found.
      RESOURCE_GROUP_NOT_FOUND = 7
    end
  end

  # Ingestion settings for Amazon MSK.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::AwsMsk::State]
  #     Output only. An output-only field that indicates the state of the Amazon
  #     MSK ingestion source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Required. The Amazon Resource Name (ARN) that uniquely identifies the
  #     cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Amazon MSK cluster that Pub/Sub
  #     will import from.
  # @!attribute [rw] aws_role_arn
  #   @return [::String]
  #     Required. AWS role ARN to be used for Federated Identity authentication
  #     with Amazon MSK. Check the Pub/Sub docs for how to set up this role and
  #     the required permissions that need to be attached to it.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call
  #     for the provided role). The `aws_role_arn` must be set up with
  #     `accounts.google.com:sub` equals to this service account number.
  class AwsMsk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Amazon MSK.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Amazon MSK.
      MSK_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided MSK cluster wasn't found.
      CLUSTER_NOT_FOUND = 4

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 5
    end
  end

  # Ingestion settings for Confluent Cloud.
  # @!attribute [r] state
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::ConfluentCloud::State]
  #     Output only. An output-only field that indicates the state of the
  #     Confluent Cloud ingestion source.
  # @!attribute [rw] bootstrap_server
  #   @return [::String]
  #     Required. The address of the bootstrap server. The format is url:port.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Required. The id of the cluster.
  # @!attribute [rw] topic
  #   @return [::String]
  #     Required. The name of the topic in the Confluent Cloud cluster that
  #     Pub/Sub will import from.
  # @!attribute [rw] identity_pool_id
  #   @return [::String]
  #     Required. The id of the identity pool to be used for Federated Identity
  #     authentication with Confluent Cloud. See
  #     https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
  # @!attribute [rw] gcp_service_account
  #   @return [::String]
  #     Required. The GCP service account to be used for Federated Identity
  #     authentication with `identity_pool_id`.
  class ConfluentCloud
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Possible states for managed ingestion from Confluent Cloud.
    module State
      # Default value. This value is unused.
      STATE_UNSPECIFIED = 0

      # Ingestion is active.
      ACTIVE = 1

      # Permission denied encountered while consuming data from Confluent
      # Cloud.
      CONFLUENT_CLOUD_PERMISSION_DENIED = 2

      # Permission denied encountered while publishing to the topic.
      PUBLISH_PERMISSION_DENIED = 3

      # The provided bootstrap server address is unreachable.
      UNREACHABLE_BOOTSTRAP_SERVER = 4

      # The provided cluster wasn't found.
      CLUSTER_NOT_FOUND = 5

      # The provided topic wasn't found.
      TOPIC_NOT_FOUND = 6
    end
  end
end