Class: Google::Cloud::Bigtable::Admin::V2::AppProfile

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

Overview

A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.

Defined Under Namespace

Modules: Priority Classes: MultiClusterRoutingUseAny, SingleClusterRouting, StandardIsolation

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns Long form description of the use case for this AppProfile.

Returns:

  • (::String) —

    Long form description of the use case for this AppProfile.



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

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

  # Read/write requests are routed to the nearest cluster in the instance, and
  # will fail over to the nearest cluster that is available in the event of
  # transient errors or delays. Clusters in a region are considered
  # equidistant. Choosing this option sacrifices read-your-writes consistency
  # to improve availability.
  # @!attribute [rw] cluster_ids
  #   @return [::Array<::String>]
  #     The set of clusters to route to. The order is ignored; clusters will be
  #     tried in order of distance. If left empty, all clusters are eligible.
  class MultiClusterRoutingUseAny
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unconditionally routes all read/write requests to a specific cluster.
  # This option preserves read-your-writes consistency but does not improve
  # availability.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     The cluster to which read/write requests should be routed.
  # @!attribute [rw] allow_transactional_writes
  #   @return [::Boolean]
  #     Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
  #     allowed by this app profile. It is unsafe to send these requests to
  #     the same table/row/column in multiple clusters.
  class SingleClusterRouting
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Standard options for isolating this app profile's traffic from other use
  # cases.
  # @!attribute [rw] priority
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority]
  #     The priority of requests sent using this app profile.
  class StandardIsolation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible priorities for an app profile. Note that higher priority writes
  # can sometimes queue behind lower priority writes to the same tablet, as
  # writes must be strictly sequenced in the durability log.
  module Priority
    # Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation.
    PRIORITY_UNSPECIFIED = 0

    PRIORITY_LOW = 1

    PRIORITY_MEDIUM = 2

    PRIORITY_HIGH = 3
  end
end

#etag ⇒ ::String

Returns Strongly validated etag for optimistic concurrency control. Preserve the value returned from GetAppProfile when calling UpdateAppProfile to fail the request if there has been a modification in the mean time. The update_mask of the request need not include etag for this protection to apply. See Wikipedia and RFC 7232 for more details.

Returns:

  • (::String) —

    Strongly validated etag for optimistic concurrency control. Preserve the value returned from GetAppProfile when calling UpdateAppProfile to fail the request if there has been a modification in the mean time. The update_mask of the request need not include etag for this protection to apply. See Wikipedia and RFC 7232 for more details.



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

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

  # Read/write requests are routed to the nearest cluster in the instance, and
  # will fail over to the nearest cluster that is available in the event of
  # transient errors or delays. Clusters in a region are considered
  # equidistant. Choosing this option sacrifices read-your-writes consistency
  # to improve availability.
  # @!attribute [rw] cluster_ids
  #   @return [::Array<::String>]
  #     The set of clusters to route to. The order is ignored; clusters will be
  #     tried in order of distance. If left empty, all clusters are eligible.
  class MultiClusterRoutingUseAny
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unconditionally routes all read/write requests to a specific cluster.
  # This option preserves read-your-writes consistency but does not improve
  # availability.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     The cluster to which read/write requests should be routed.
  # @!attribute [rw] allow_transactional_writes
  #   @return [::Boolean]
  #     Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
  #     allowed by this app profile. It is unsafe to send these requests to
  #     the same table/row/column in multiple clusters.
  class SingleClusterRouting
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Standard options for isolating this app profile's traffic from other use
  # cases.
  # @!attribute [rw] priority
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority]
  #     The priority of requests sent using this app profile.
  class StandardIsolation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible priorities for an app profile. Note that higher priority writes
  # can sometimes queue behind lower priority writes to the same tablet, as
  # writes must be strictly sequenced in the durability log.
  module Priority
    # Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation.
    PRIORITY_UNSPECIFIED = 0

    PRIORITY_LOW = 1

    PRIORITY_MEDIUM = 2

    PRIORITY_HIGH = 3
  end
end

#multi_cluster_routing_use_any ⇒ ::Google::Cloud::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny

Returns Use a multi-cluster routing policy.

Returns:



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

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

  # Read/write requests are routed to the nearest cluster in the instance, and
  # will fail over to the nearest cluster that is available in the event of
  # transient errors or delays. Clusters in a region are considered
  # equidistant. Choosing this option sacrifices read-your-writes consistency
  # to improve availability.
  # @!attribute [rw] cluster_ids
  #   @return [::Array<::String>]
  #     The set of clusters to route to. The order is ignored; clusters will be
  #     tried in order of distance. If left empty, all clusters are eligible.
  class MultiClusterRoutingUseAny
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unconditionally routes all read/write requests to a specific cluster.
  # This option preserves read-your-writes consistency but does not improve
  # availability.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     The cluster to which read/write requests should be routed.
  # @!attribute [rw] allow_transactional_writes
  #   @return [::Boolean]
  #     Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
  #     allowed by this app profile. It is unsafe to send these requests to
  #     the same table/row/column in multiple clusters.
  class SingleClusterRouting
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Standard options for isolating this app profile's traffic from other use
  # cases.
  # @!attribute [rw] priority
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority]
  #     The priority of requests sent using this app profile.
  class StandardIsolation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible priorities for an app profile. Note that higher priority writes
  # can sometimes queue behind lower priority writes to the same tablet, as
  # writes must be strictly sequenced in the durability log.
  module Priority
    # Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation.
    PRIORITY_UNSPECIFIED = 0

    PRIORITY_LOW = 1

    PRIORITY_MEDIUM = 2

    PRIORITY_HIGH = 3
  end
end

#name ⇒ ::String

Returns The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*.

Returns:

  • (::String) —

    The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*.



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

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

  # Read/write requests are routed to the nearest cluster in the instance, and
  # will fail over to the nearest cluster that is available in the event of
  # transient errors or delays. Clusters in a region are considered
  # equidistant. Choosing this option sacrifices read-your-writes consistency
  # to improve availability.
  # @!attribute [rw] cluster_ids
  #   @return [::Array<::String>]
  #     The set of clusters to route to. The order is ignored; clusters will be
  #     tried in order of distance. If left empty, all clusters are eligible.
  class MultiClusterRoutingUseAny
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unconditionally routes all read/write requests to a specific cluster.
  # This option preserves read-your-writes consistency but does not improve
  # availability.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     The cluster to which read/write requests should be routed.
  # @!attribute [rw] allow_transactional_writes
  #   @return [::Boolean]
  #     Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
  #     allowed by this app profile. It is unsafe to send these requests to
  #     the same table/row/column in multiple clusters.
  class SingleClusterRouting
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Standard options for isolating this app profile's traffic from other use
  # cases.
  # @!attribute [rw] priority
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority]
  #     The priority of requests sent using this app profile.
  class StandardIsolation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible priorities for an app profile. Note that higher priority writes
  # can sometimes queue behind lower priority writes to the same tablet, as
  # writes must be strictly sequenced in the durability log.
  module Priority
    # Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation.
    PRIORITY_UNSPECIFIED = 0

    PRIORITY_LOW = 1

    PRIORITY_MEDIUM = 2

    PRIORITY_HIGH = 3
  end
end

#priority ⇒ ::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns This field has been deprecated in favor of standard_isolation.priority. If you set this field, standard_isolation.priority will be set instead.

The priority of requests sent using this app profile.

Returns:



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

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

  # Read/write requests are routed to the nearest cluster in the instance, and
  # will fail over to the nearest cluster that is available in the event of
  # transient errors or delays. Clusters in a region are considered
  # equidistant. Choosing this option sacrifices read-your-writes consistency
  # to improve availability.
  # @!attribute [rw] cluster_ids
  #   @return [::Array<::String>]
  #     The set of clusters to route to. The order is ignored; clusters will be
  #     tried in order of distance. If left empty, all clusters are eligible.
  class MultiClusterRoutingUseAny
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unconditionally routes all read/write requests to a specific cluster.
  # This option preserves read-your-writes consistency but does not improve
  # availability.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     The cluster to which read/write requests should be routed.
  # @!attribute [rw] allow_transactional_writes
  #   @return [::Boolean]
  #     Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
  #     allowed by this app profile. It is unsafe to send these requests to
  #     the same table/row/column in multiple clusters.
  class SingleClusterRouting
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Standard options for isolating this app profile's traffic from other use
  # cases.
  # @!attribute [rw] priority
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority]
  #     The priority of requests sent using this app profile.
  class StandardIsolation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible priorities for an app profile. Note that higher priority writes
  # can sometimes queue behind lower priority writes to the same tablet, as
  # writes must be strictly sequenced in the durability log.
  module Priority
    # Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation.
    PRIORITY_UNSPECIFIED = 0

    PRIORITY_LOW = 1

    PRIORITY_MEDIUM = 2

    PRIORITY_HIGH = 3
  end
end

#single_cluster_routing ⇒ ::Google::Cloud::Bigtable::Admin::V2::AppProfile::SingleClusterRouting

Returns Use a single-cluster routing policy.

Returns:



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

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

  # Read/write requests are routed to the nearest cluster in the instance, and
  # will fail over to the nearest cluster that is available in the event of
  # transient errors or delays. Clusters in a region are considered
  # equidistant. Choosing this option sacrifices read-your-writes consistency
  # to improve availability.
  # @!attribute [rw] cluster_ids
  #   @return [::Array<::String>]
  #     The set of clusters to route to. The order is ignored; clusters will be
  #     tried in order of distance. If left empty, all clusters are eligible.
  class MultiClusterRoutingUseAny
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unconditionally routes all read/write requests to a specific cluster.
  # This option preserves read-your-writes consistency but does not improve
  # availability.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     The cluster to which read/write requests should be routed.
  # @!attribute [rw] allow_transactional_writes
  #   @return [::Boolean]
  #     Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
  #     allowed by this app profile. It is unsafe to send these requests to
  #     the same table/row/column in multiple clusters.
  class SingleClusterRouting
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Standard options for isolating this app profile's traffic from other use
  # cases.
  # @!attribute [rw] priority
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority]
  #     The priority of requests sent using this app profile.
  class StandardIsolation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible priorities for an app profile. Note that higher priority writes
  # can sometimes queue behind lower priority writes to the same tablet, as
  # writes must be strictly sequenced in the durability log.
  module Priority
    # Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation.
    PRIORITY_UNSPECIFIED = 0

    PRIORITY_LOW = 1

    PRIORITY_MEDIUM = 2

    PRIORITY_HIGH = 3
  end
end

#standard_isolation ⇒ ::Google::Cloud::Bigtable::Admin::V2::AppProfile::StandardIsolation

Returns The standard options used for isolating this app profile's traffic from other use cases.

Returns:



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

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

  # Read/write requests are routed to the nearest cluster in the instance, and
  # will fail over to the nearest cluster that is available in the event of
  # transient errors or delays. Clusters in a region are considered
  # equidistant. Choosing this option sacrifices read-your-writes consistency
  # to improve availability.
  # @!attribute [rw] cluster_ids
  #   @return [::Array<::String>]
  #     The set of clusters to route to. The order is ignored; clusters will be
  #     tried in order of distance. If left empty, all clusters are eligible.
  class MultiClusterRoutingUseAny
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unconditionally routes all read/write requests to a specific cluster.
  # This option preserves read-your-writes consistency but does not improve
  # availability.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     The cluster to which read/write requests should be routed.
  # @!attribute [rw] allow_transactional_writes
  #   @return [::Boolean]
  #     Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
  #     allowed by this app profile. It is unsafe to send these requests to
  #     the same table/row/column in multiple clusters.
  class SingleClusterRouting
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Standard options for isolating this app profile's traffic from other use
  # cases.
  # @!attribute [rw] priority
  #   @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority]
  #     The priority of requests sent using this app profile.
  class StandardIsolation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible priorities for an app profile. Note that higher priority writes
  # can sometimes queue behind lower priority writes to the same tablet, as
  # writes must be strictly sequenced in the durability log.
  module Priority
    # Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation.
    PRIORITY_UNSPECIFIED = 0

    PRIORITY_LOW = 1

    PRIORITY_MEDIUM = 2

    PRIORITY_HIGH = 3
  end
end