Skip to content

Commit

Permalink
Merge pull request #238 from inspec/sa/bigtable_admin_api
Browse files Browse the repository at this point in the history
Duplicate entry for ProjectInstanceCluster is removed
  • Loading branch information
sa-progress authored Jul 25, 2024
2 parents 613e726 + 871e73d commit 27f40e7
Showing 1 changed file with 0 additions and 123 deletions.
123 changes: 0 additions & 123 deletions mmv1/products/bigtableadmin/api.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

--- !ruby/object:Api::Product
name: bigtableadmin
display_name: bigtableadmin
Expand Down Expand Up @@ -118,125 +117,3 @@ objects:
name: 'kmsKeyName'
description: |
Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`

--- !ruby/object:Api::Product
name: bigtableadmin
display_name: bigtableadmin
versions:
- !ruby/object:Api::Product::Version
name: ga
base_url: https://bigtableadmin.googleapis.com//v2/
scopes:
- https://bigtableadmin.googleapis.com//auth/cloud-platform
apis_required:
- !ruby/object:Api::Product::ApiReference
name: https://bigtableadmin.googleapis.com/
url: https://console.cloud.google.com/apis/library/bigtableadmin.googleapis.com/
objects:

- !ruby/object:Api::Resource
name: ProjectInstanceCluster
base_url: '{{+parent}}/clusters'
self_link: '{{+name}}'
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Official Documentation':
api: 'https://cloud.google.com/bigtableadmin/docs'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
path: 'name'
base_url: '{op_id}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'response'
resource_inside_response: true
status: !ruby/object:Api::OpAsync::Status
path: 'done'
complete: True
allowed:
- True
- False
error: !ruby/object:Api::OpAsync::Error
path: 'error'
message: 'message'
description: |-
A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
properties:

- !ruby/object:Api::Type::String
name: 'name'
description: |
The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
- !ruby/object:Api::Type::String
name: 'location'
description: |
Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
- !ruby/object:Api::Type::Enum
name: 'state'
description: |
Output only. The current state of the cluster.
values:
- :STATE_NOT_KNOWN
- :READY
- :CREATING
- :RESIZING
- :DISABLED
- !ruby/object:Api::Type::Integer
name: 'serveNodes'
description: |
The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
- !ruby/object:Api::Type::NestedObject
name: 'clusterConfig'
description: |
Configuration for a cluster.
properties:
- !ruby/object:Api::Type::NestedObject
name: 'clusterAutoscalingConfig'
description: |
Autoscaling config for a cluster.
properties:
- !ruby/object:Api::Type::NestedObject
name: 'autoscalingLimits'
description: |
Limits for the number of nodes a Cluster can autoscale up/down to.
properties:
- !ruby/object:Api::Type::Integer
name: 'minServeNodes'
description: |
Required. Minimum number of nodes to scale down to.
- !ruby/object:Api::Type::Integer
name: 'maxServeNodes'
description: |
Required. Maximum number of nodes to scale up to.
- !ruby/object:Api::Type::NestedObject
name: 'autoscalingTargets'
description: |
The Autoscaling targets for a Cluster. These determine the recommended nodes.
properties:
- !ruby/object:Api::Type::Integer
name: 'cpuUtilizationPercent'
description: |
The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80, otherwise it will return INVALID_ARGUMENT error.
- !ruby/object:Api::Type::Integer
name: 'storageUtilizationGibPerNode'
description: |
The storage utilization that the Autoscaler should be trying to achieve. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster, otherwise it will return INVALID_ARGUMENT error. If this value is set to 0, it will be treated as if it were set to the default value: 2560 for SSD, 8192 for HDD.
- !ruby/object:Api::Type::Enum
name: 'defaultStorageType'
description: |
Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
values:
- :STORAGE_TYPE_UNSPECIFIED
- :SSD
- :HDD
- !ruby/object:Api::Type::NestedObject
name: 'encryptionConfig'
description: |
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
properties:
- !ruby/object:Api::Type::String
name: 'kmsKeyName'
description: |
Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`

0 comments on commit 27f40e7

Please sign in to comment.