Class: Google::Cloud::Bigtable::Admin::V2::AuthorizedView

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/admin/v2/table.rb

Overview

AuthorizedViews represent subsets of a particular Cloud Bigtable table. Users can configure access to each Authorized View independently from the table and use the existing Data APIs to access the subset of data.

Defined Under Namespace

Modules: ResponseView Classes: FamilySubsets, SubsetView

Instance Attribute Summary collapse

Instance Attribute Details

#deletion_protection ⇒ ::Boolean

Returns Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set.

Returns:

  • (::Boolean) —

    Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set.



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
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 292

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

  # Subsets of a column family that are included in this AuthorizedView.
  # @!attribute [rw] qualifiers
  #   @return [::Array<::String>]
  #     Individual exact column qualifiers to be included in the AuthorizedView.
  # @!attribute [rw] qualifier_prefixes
  #   @return [::Array<::String>]
  #     Prefixes for qualifiers to be included in the AuthorizedView. Every
  #     qualifier starting with one of these prefixes is included in the
  #     AuthorizedView. To provide access to all qualifiers, include the empty
  #     string as a prefix
  #     ("").
  class FamilySubsets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a simple AuthorizedView that is a subset of the underlying Table.
  # @!attribute [rw] row_prefixes
  #   @return [::Array<::String>]
  #     Row prefixes to be included in the AuthorizedView.
  #     To provide access to all rows, include the empty string as a prefix ("").
  # @!attribute [rw] family_subsets
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::FamilySubsets}]
  #     Map from column family name to the columns in this family to be included
  #     in the AuthorizedView.
  class SubsetView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::FamilySubsets]
    class FamilySubsetsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Defines a subset of an AuthorizedView's fields.
  module ResponseView
    # Uses the default view for each method as documented in the request.
    RESPONSE_VIEW_UNSPECIFIED = 0

    # Only populates `name`.
    NAME_ONLY = 1

    # Only populates the AuthorizedView's basic metadata. This includes:
    # name, deletion_protection, etag.
    BASIC = 2

    # Populates every fields.
    FULL = 3
  end
end

#etag ⇒ ::String

The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag.

Returns:

  • (::String) —

    The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag.



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
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 292

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

  # Subsets of a column family that are included in this AuthorizedView.
  # @!attribute [rw] qualifiers
  #   @return [::Array<::String>]
  #     Individual exact column qualifiers to be included in the AuthorizedView.
  # @!attribute [rw] qualifier_prefixes
  #   @return [::Array<::String>]
  #     Prefixes for qualifiers to be included in the AuthorizedView. Every
  #     qualifier starting with one of these prefixes is included in the
  #     AuthorizedView. To provide access to all qualifiers, include the empty
  #     string as a prefix
  #     ("").
  class FamilySubsets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a simple AuthorizedView that is a subset of the underlying Table.
  # @!attribute [rw] row_prefixes
  #   @return [::Array<::String>]
  #     Row prefixes to be included in the AuthorizedView.
  #     To provide access to all rows, include the empty string as a prefix ("").
  # @!attribute [rw] family_subsets
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::FamilySubsets}]
  #     Map from column family name to the columns in this family to be included
  #     in the AuthorizedView.
  class SubsetView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::FamilySubsets]
    class FamilySubsetsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Defines a subset of an AuthorizedView's fields.
  module ResponseView
    # Uses the default view for each method as documented in the request.
    RESPONSE_VIEW_UNSPECIFIED = 0

    # Only populates `name`.
    NAME_ONLY = 1

    # Only populates the AuthorizedView's basic metadata. This includes:
    # name, deletion_protection, etag.
    BASIC = 2

    # Populates every fields.
    FULL = 3
  end
end

#name ⇒ ::String

Returns Identifier. The name of this AuthorizedView. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}.

Returns:

  • (::String) —

    Identifier. The name of this AuthorizedView. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}



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
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 292

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

  # Subsets of a column family that are included in this AuthorizedView.
  # @!attribute [rw] qualifiers
  #   @return [::Array<::String>]
  #     Individual exact column qualifiers to be included in the AuthorizedView.
  # @!attribute [rw] qualifier_prefixes
  #   @return [::Array<::String>]
  #     Prefixes for qualifiers to be included in the AuthorizedView. Every
  #     qualifier starting with one of these prefixes is included in the
  #     AuthorizedView. To provide access to all qualifiers, include the empty
  #     string as a prefix
  #     ("").
  class FamilySubsets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a simple AuthorizedView that is a subset of the underlying Table.
  # @!attribute [rw] row_prefixes
  #   @return [::Array<::String>]
  #     Row prefixes to be included in the AuthorizedView.
  #     To provide access to all rows, include the empty string as a prefix ("").
  # @!attribute [rw] family_subsets
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::FamilySubsets}]
  #     Map from column family name to the columns in this family to be included
  #     in the AuthorizedView.
  class SubsetView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::FamilySubsets]
    class FamilySubsetsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Defines a subset of an AuthorizedView's fields.
  module ResponseView
    # Uses the default view for each method as documented in the request.
    RESPONSE_VIEW_UNSPECIFIED = 0

    # Only populates `name`.
    NAME_ONLY = 1

    # Only populates the AuthorizedView's basic metadata. This includes:
    # name, deletion_protection, etag.
    BASIC = 2

    # Populates every fields.
    FULL = 3
  end
end

#subset_view ⇒ ::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::SubsetView

Returns An AuthorizedView permitting access to an explicit subset of a Table.

Returns:



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
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 292

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

  # Subsets of a column family that are included in this AuthorizedView.
  # @!attribute [rw] qualifiers
  #   @return [::Array<::String>]
  #     Individual exact column qualifiers to be included in the AuthorizedView.
  # @!attribute [rw] qualifier_prefixes
  #   @return [::Array<::String>]
  #     Prefixes for qualifiers to be included in the AuthorizedView. Every
  #     qualifier starting with one of these prefixes is included in the
  #     AuthorizedView. To provide access to all qualifiers, include the empty
  #     string as a prefix
  #     ("").
  class FamilySubsets
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines a simple AuthorizedView that is a subset of the underlying Table.
  # @!attribute [rw] row_prefixes
  #   @return [::Array<::String>]
  #     Row prefixes to be included in the AuthorizedView.
  #     To provide access to all rows, include the empty string as a prefix ("").
  # @!attribute [rw] family_subsets
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::FamilySubsets}]
  #     Map from column family name to the columns in this family to be included
  #     in the AuthorizedView.
  class SubsetView
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::Bigtable::Admin::V2::AuthorizedView::FamilySubsets]
    class FamilySubsetsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Defines a subset of an AuthorizedView's fields.
  module ResponseView
    # Uses the default view for each method as documented in the request.
    RESPONSE_VIEW_UNSPECIFIED = 0

    # Only populates `name`.
    NAME_ONLY = 1

    # Only populates the AuthorizedView's basic metadata. This includes:
    # name, deletion_protection, etag.
    BASIC = 2

    # Populates every fields.
    FULL = 3
  end
end