Class: Google::Apis::BigtableadminV2::Instance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigtableadmin_v2/classes.rb,
lib/google/apis/bigtableadmin_v2/representations.rb,
lib/google/apis/bigtableadmin_v2/representations.rb

Overview

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



2960
2961
2962
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2960

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1. Corresponds to the JSON property createTime

Returns:

  • (String) 


2891
2892
2893
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2891

def create_time
  @create_time
end

#display_name ⇒ String

Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. Corresponds to the JSON property displayName

Returns:

  • (String) 


2897
2898
2899
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2897

def display_name
  @display_name
end

#edition ⇒ String

Optional. The edition of the instance. See Edition for details. Corresponds to the JSON property edition

Returns:

  • (String) 


2902
2903
2904
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2902

def edition
  @edition
end

#knowledge_catalog_region ⇒ String

Output only. The region where Knowledge Catalog data is synced to and stored, including user-created aspects. Corresponds to the JSON property knowledgeCatalogRegion

Returns:

  • (String) 


2908
2909
2910
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2908

def knowledge_catalog_region
  @knowledge_catalog_region
end

#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 deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: \pLl\pLo0,62. * Label values must be between 0 and 63 characters long and must conform to the regular expression: [\pLl\pLo\ pN_-]0,63`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. Corresponds to the JSON propertylabels`

Returns:

  • (Hash<String,String>) 


2920
2921
2922
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2920

def labels
  @labels
end

#name ⇒ String

The unique name of the instance. Values are of the form projects/project/ instances/a-z+[a-z0-9]. Corresponds to the JSON property name

Returns:

  • (String) 


2926
2927
2928
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2926

def name
  @name
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


2931
2932
2933
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2931

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


2937
2938
2939
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2937

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

Output only. The current state of the instance. Corresponds to the JSON property state

Returns:

  • (String) 


2943
2944
2945
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2943

def state
  @state
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": " marketing" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/ tags/tags-overview for an in-depth overview on the difference between tags and labels. Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


2953
2954
2955
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2953

def tags
  @tags
end

#type ⇒ String

The type of the instance. Defaults to PRODUCTION. Corresponds to the JSON property type

Returns:

  • (String) 


2958
2959
2960
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2958

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 2965

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @edition = args[:edition] if args.key?(:edition)
  @knowledge_catalog_region = args[:knowledge_catalog_region] if args.key?(:knowledge_catalog_region)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @state = args[:state] if args.key?(:state)
  @tags = args[:tags] if args.key?(:tags)
  @type = args[:type] if args.key?(:type)
end