Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ def list_instances request, options = nil
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload update_instance(name: nil, display_name: nil, type: nil, labels: nil, tags: nil)
# @overload update_instance(name: nil, display_name: nil, type: nil, edition: nil, labels: nil, tags: nil)
# Pass arguments to `update_instance` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
Expand All @@ -595,6 +595,9 @@ def list_instances request, options = nil
# to avoid confusion.
# @param type [::Google::Cloud::Bigtable::Admin::V2::Instance::Type]
# The type of the instance. Defaults to `PRODUCTION`.
# @param edition [::Google::Cloud::Bigtable::Admin::V2::Instance::Edition]
# Optional. The edition of the instance. See
# {::Google::Cloud::Bigtable::Admin::V2::Instance::Edition Edition} for details.
# @param labels [::Hash{::String => ::String}]
# Labels are a flexible and lightweight mechanism for organizing cloud
# resources into groups that reflect a customer's organizational needs and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,23 @@ def instance_path project:, instance:
"projects/#{project}/instances/#{instance}"
end

##
# Create a fully-qualified Location resource string.
#
# The resource will be in the following format:
#
# `projects/{project}/locations/{location}`
#
# @param project [String]
# @param location [String]
#
# @return [::String]
def location_path project:, location:
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

"projects/#{project}/locations/#{location}"
end

##
# Create a fully-qualified SchemaBundle resource string.
#
Expand Down
178 changes: 149 additions & 29 deletions google-cloud-bigtable-admin-v2/proto_docs/google/api/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ module Api
# @!attribute [rw] selective_gapic_generation
# @return [::Google::Api::SelectiveGapicGeneration]
# Configuration for which RPCs should be generated in the GAPIC client.
#
# Note: This field should not be used in most cases.
class CommonLanguageSettings
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -141,9 +143,10 @@ class Publishing
#
# Example of a YAML configuration::
#
# publishing:
# java_settings:
# library_package: com.google.cloud.pubsub.v1
# publishing:
# library_settings:
# java_settings:
# library_package: com.google.cloud.pubsub.v1
# @!attribute [rw] service_class_names
# @return [::Google::Protobuf::Map{::String => ::String}]
# Configure the Java class name to use instead of the service's for its
Expand All @@ -155,11 +158,11 @@ class Publishing
#
# Example of a YAML configuration::
#
# publishing:
# java_settings:
# service_class_names:
# - google.pubsub.v1.Publisher: TopicAdmin
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
# publishing:
# java_settings:
# service_class_names:
# - google.pubsub.v1.Publisher: TopicAdmin
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
# @!attribute [rw] common
# @return [::Google::Api::CommonLanguageSettings]
# Some settings.
Expand Down Expand Up @@ -190,6 +193,20 @@ class CppSettings
# @!attribute [rw] common
# @return [::Google::Api::CommonLanguageSettings]
# Some settings.
# @!attribute [rw] library_package
# @return [::String]
# The package name to use in Php. Clobbers the php_namespace option
# set in the protobuf. This should be used **only** by APIs
# who have already set the language_settings.php.package_name" field
# in gapic.yaml. API teams should use the protobuf php_namespace option
# where possible.
#
# Example of a YAML configuration::
#
# publishing:
# library_settings:
# php_settings:
# library_package: Google\Cloud\PubSub\V1
class PhpSettings
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -318,10 +335,12 @@ class RubySettings
# service names and values are the name to be used for the service client
# and call options.
#
# publishing:
# go_settings:
# renamed_services:
# Publisher: TopicAdmin
# Example:
#
# publishing:
# go_settings:
# renamed_services:
# Publisher: TopicAdmin
class GoSettings
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand All @@ -344,10 +363,10 @@ class RenamedServicesEntry
#
# Example:
#
# publishing:
# method_settings:
# - selector: google.storage.control.v2.StorageControl.CreateFolder
# # method settings for CreateFolder...
# publishing:
# method_settings:
# - selector: google.storage.control.v2.StorageControl.CreateFolder
# # method settings for CreateFolder...
# @!attribute [rw] long_running
# @return [::Google::Api::MethodSettings::LongRunning]
# Describes settings to use for long-running operations when generating
Expand All @@ -356,14 +375,14 @@ class RenamedServicesEntry
#
# Example of a YAML configuration::
#
# publishing:
# method_settings:
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
# long_running:
# initial_poll_delay: 60s # 1 minute
# poll_delay_multiplier: 1.5
# max_poll_delay: 360s # 6 minutes
# total_poll_timeout: 54000s # 90 minutes
# publishing:
# method_settings:
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
# long_running:
# initial_poll_delay: 60s # 1 minute
# poll_delay_multiplier: 1.5
# max_poll_delay: 360s # 6 minutes
# total_poll_timeout: 54000s # 90 minutes
# @!attribute [rw] auto_populated_fields
# @return [::Array<::String>]
# List of top-level fields of the request message, that should be
Expand All @@ -372,11 +391,24 @@ class RenamedServicesEntry
#
# Example of a YAML configuration:
#
# publishing:
# method_settings:
# - selector: google.example.v1.ExampleService.CreateExample
# auto_populated_fields:
# - request_id
# publishing:
# method_settings:
# - selector: google.example.v1.ExampleService.CreateExample
# auto_populated_fields:
# - request_id
# @!attribute [rw] batching
# @return [::Google::Api::BatchingConfigProto]
# Batching configuration for an API method in client libraries.
#
# Example of a YAML configuration:
#
# publishing:
# method_settings:
# - selector: google.example.v1.ExampleService.BatchCreateExample
# batching:
# element_count_threshold: 1000
# request_byte_threshold: 100000000
# delay_threshold_millis: 10
class MethodSettings
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -411,6 +443,8 @@ class LongRunning

# This message is used to configure the generation of a subset of the RPCs in
# a service for client libraries.
#
# Note: This feature should not be used in most cases.
# @!attribute [rw] methods
# @return [::Array<::String>]
# An allowlist of the fully qualified names of RPCs that should be included
Expand All @@ -428,6 +462,77 @@ class SelectiveGapicGeneration
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# `BatchingConfigProto` defines the batching configuration for an API method.
# @!attribute [rw] thresholds
# @return [::Google::Api::BatchingSettingsProto]
# The thresholds which trigger a batched request to be sent.
# @!attribute [rw] batch_descriptor
# @return [::Google::Api::BatchingDescriptorProto]
# The request and response fields used in batching.
class BatchingConfigProto
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# `BatchingSettingsProto` specifies a set of batching thresholds, each of
# which acts as a trigger to send a batch of messages as a request. At least
# one threshold must be positive nonzero.
# @!attribute [rw] element_count_threshold
# @return [::Integer]
# The number of elements of a field collected into a batch which, if
# exceeded, causes the batch to be sent.
# @!attribute [rw] request_byte_threshold
# @return [::Integer]
# The aggregated size of the batched field which, if exceeded, causes the
# batch to be sent. This size is computed by aggregating the sizes of the
# request field to be batched, not of the entire request message.
# @!attribute [rw] delay_threshold
# @return [::Google::Protobuf::Duration]
# The duration after which a batch should be sent, starting from the addition
# of the first message to that batch.
# @!attribute [rw] element_count_limit
# @return [::Integer]
# The maximum number of elements collected in a batch that could be accepted
# by server.
# @!attribute [rw] request_byte_limit
# @return [::Integer]
# The maximum size of the request that could be accepted by server.
# @!attribute [rw] flow_control_element_limit
# @return [::Integer]
# The maximum number of elements allowed by flow control.
# @!attribute [rw] flow_control_byte_limit
# @return [::Integer]
# The maximum size of data allowed by flow control.
# @!attribute [rw] flow_control_limit_exceeded_behavior
# @return [::Google::Api::FlowControlLimitExceededBehaviorProto]
# The behavior to take when the flow control limit is exceeded.
class BatchingSettingsProto
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# `BatchingDescriptorProto` specifies the fields of the request message to be
# used for batching, and, optionally, the fields of the response message to be
# used for demultiplexing.
# @!attribute [rw] batched_field
# @return [::String]
# The repeated field in the request message to be aggregated by batching.
# @!attribute [rw] discriminator_fields
# @return [::Array<::String>]
# A list of the fields in the request message. Two requests will be batched
# together only if the values of every field specified in
# `request_discriminator_fields` is equal between the two requests.
# @!attribute [rw] subresponse_field
# @return [::String]
# Optional. When present, indicates the field in the response message to be
# used to demultiplex the response into multiple response messages, in
# correspondence with the multiple request messages originally batched
# together.
class BatchingDescriptorProto
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# The organization for which the client libraries are being published.
# Affects the url where generated docs are published, etc.
module ClientLibraryOrganization
Expand Down Expand Up @@ -469,5 +574,20 @@ module ClientLibraryDestination
# Publish the library to package managers like nuget.org and npmjs.com.
PACKAGE_MANAGER = 20
end

# The behavior to take when the flow control limit is exceeded.
module FlowControlLimitExceededBehaviorProto
# Default behavior, system-defined.
UNSET_BEHAVIOR = 0

# Stop operation, raise error.
THROW_EXCEPTION = 1

# Pause operation until limit clears.
BLOCK = 2

# Continue operation, disregard limit.
IGNORE = 3
end
end
end
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ module V2
# @!attribute [rw] type
# @return [::Google::Cloud::Bigtable::Admin::V2::Instance::Type]
# The type of the instance. Defaults to `PRODUCTION`.
# @!attribute [rw] edition
# @return [::Google::Cloud::Bigtable::Admin::V2::Instance::Edition]
# Optional. The edition of the instance. See
# {::Google::Cloud::Bigtable::Admin::V2::Instance::Edition Edition} for details.
# @!attribute [rw] labels
# @return [::Google::Protobuf::Map{::String => ::String}]
# Labels are a flexible and lightweight mechanism for organizing cloud
Expand Down Expand Up @@ -127,6 +131,29 @@ module Type
# a higher minimum node count than DEVELOPMENT.
DEVELOPMENT = 2
end

# Possible editions of an instance.
#
# An edition is a specific tier of Cloud Bigtable. Each edition is tailored
# to different customer needs. Higher tiers offer more features and better
# performance.
module Edition
# The edition is unspecified. This is treated as `ENTERPRISE`.
EDITION_UNSPECIFIED = 0

# The Enterprise edition. This is the default offering that is designed to
# meet the needs of most enterprise workloads.
ENTERPRISE = 1

# The Enterprise Plus edition. This is a premium tier that is designed for
# demanding, multi-tenant workloads requiring the highest levels of
# performance, scale, and global availability.
#
# The nodes in the Enterprise Plus tier come at a higher cost than the
# Enterprise tier. Any Enterprise Plus features must be disabled before
# downgrading to Enterprise.
ENTERPRISE_PLUS = 2
end
end

# The Autoscaling targets for a Cluster. These determine the recommended nodes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,12 +214,19 @@ module ReplicationState
# Defines an automated backup policy for a table
# @!attribute [rw] retention_period
# @return [::Google::Protobuf::Duration]
# Required. How long the automated backups should be retained. The only
# supported value at this time is 3 days.
# Required. How long the automated backups should be retained. Values must
# be at least 3 days and at most 90 days.
# @!attribute [rw] frequency
# @return [::Google::Protobuf::Duration]
# Required. How frequently automated backups should occur. The only
# supported value at this time is 24 hours.
# How frequently automated backups should occur. The only supported value
# at this time is 24 hours. An undefined frequency is treated as 24 hours.
# @!attribute [rw] locations
# @return [::Array<::String>]
# Optional. A list of Cloud Bigtable zones where automated backups are
# allowed to be created. If empty, automated backups will be created in all
# zones of the instance. Locations are in the format
# `projects/{project}/locations/{zone}`.
# This field can only set for tables in Enterprise Plus instances.
class AutomatedBackupPolicy
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down
Loading
Loading