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

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

Overview

Ingestion settings for Cloud Storage.

Defined Under Namespace

Modules: State Classes: AvroFormat, PubSubAvroFormat, TextFormat

Instance Attribute Summary collapse

Instance Attribute Details

#avro_format ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat

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

Returns:



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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 199

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

#bucket ⇒ ::String

Returns Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.

Returns:

  • (::String) —

    Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.



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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 199

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

#match_glob ⇒ ::String

Returns Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the supported patterns.

Returns:

  • (::String) —

    Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the supported patterns.



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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 199

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

#minimum_object_create_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. Only objects with a larger or equal creation timestamp will be ingested.

Returns:



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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 199

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

#pubsub_avro_format ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::PubSubAvroFormat

Returns Optional. It will be assumed data from Cloud Storage was written via Cloud Storage subscriptions.

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.

Returns:



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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 199

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

#state ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::State (readonly)

Returns Output only. An output-only field that indicates the state of the Cloud Storage ingestion source.

Returns:



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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 199

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

#text_format ⇒ ::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::TextFormat

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

Returns:



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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 199

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