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, CloudStorage

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Optional. Amazon Kinesis Data Streams.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 81

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.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  # @!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).
  # @!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
end

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

Returns Optional. Cloud Storage.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 81

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.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  # @!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).
  # @!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
end

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

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

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 81

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.
  # @!attribute [rw] avro_format
  #   @return [::Google::Cloud::PubSub::V1::IngestionDataSourceSettings::CloudStorage::AvroFormat]
  #     Optional. Data from Cloud Storage will be interpreted in Avro format.
  # @!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).
  # @!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
end