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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/admin/v2/doc/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

Classes: MultiClusterRoutingUseAny, SingleClusterRouting

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

Returns Optional long form description of the use case for this AppProfile.

Returns:

  • (String) —

    Optional long form description of the use case for this AppProfile.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 171

class AppProfile
  # Read/write requests may be routed to any cluster in the instance, and will
  # fail over to another cluster in the event of transient errors or delays.
  # Choosing this option sacrifices read-your-writes consistency to improve
  # availability.
  class MultiClusterRoutingUseAny; 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 [true, false]
  #     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; 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.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 171

class AppProfile
  # Read/write requests may be routed to any cluster in the instance, and will
  # fail over to another cluster in the event of transient errors or delays.
  # Choosing this option sacrifices read-your-writes consistency to improve
  # availability.
  class MultiClusterRoutingUseAny; 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 [true, false]
  #     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; end
end

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

Returns Use a multi-cluster routing policy that may pick any cluster.

Returns:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 171

class AppProfile
  # Read/write requests may be routed to any cluster in the instance, and will
  # fail over to another cluster in the event of transient errors or delays.
  # Choosing this option sacrifices read-your-writes consistency to improve
  # availability.
  class MultiClusterRoutingUseAny; 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 [true, false]
  #     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; end
end

#name ⇒ String

Returns (+OutputOnly+) The unique name of the app profile. Values are of the form +projects//instances//appProfiles/[a-zA-Z0-9][-.a-zA-Z0-9]*+.

Returns:

  • (String) —

    (+OutputOnly+) The unique name of the app profile. Values are of the form +projects//instances//appProfiles/[a-zA-Z0-9][-.a-zA-Z0-9]*+.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 171

class AppProfile
  # Read/write requests may be routed to any cluster in the instance, and will
  # fail over to another cluster in the event of transient errors or delays.
  # Choosing this option sacrifices read-your-writes consistency to improve
  # availability.
  class MultiClusterRoutingUseAny; 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 [true, false]
  #     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; end
end

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

Returns Use a single-cluster routing policy.

Returns:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb', line 171

class AppProfile
  # Read/write requests may be routed to any cluster in the instance, and will
  # fail over to another cluster in the event of transient errors or delays.
  # Choosing this option sacrifices read-your-writes consistency to improve
  # availability.
  class MultiClusterRoutingUseAny; 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 [true, false]
  #     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; end
end