Class: Google::Apis::MemcacheV1::Instance

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

Overview

A Memorystore for Memcached instance

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



846
847
848
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 846

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

Instance Attribute Details

#authorized_network ⇒ String

The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used. Corresponds to the JSON property authorizedNetwork

Returns:

  • (String) 


750
751
752
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 750

def authorized_network
  @authorized_network
end

#create_time ⇒ String

Output only. The time the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


755
756
757
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 755

def create_time
  @create_time
end

#discovery_endpoint ⇒ String

Output only. Endpoint for the Discovery API. Corresponds to the JSON property discoveryEndpoint

Returns:

  • (String) 


760
761
762
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 760

def discovery_endpoint
  @discovery_endpoint
end

#display_name ⇒ String

User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


766
767
768
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 766

def display_name
  @display_name
end

#instance_messages ⇒ Array<Google::Apis::MemcacheV1::InstanceMessage>

List of messages that describe the current state of the Memcached instance. Corresponds to the JSON property instanceMessages

Returns:



771
772
773
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 771

def instance_messages
  @instance_messages
end

#labels ⇒ Hash<String,String>

Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/ docs/labeling-resources Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


778
779
780
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 778

def labels
  @labels
end

#memcache_full_version ⇒ String

Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached- 1.5.16". Corresponds to the JSON property memcacheFullVersion

Returns:

  • (String) 


786
787
788
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 786

def memcache_full_version
  @memcache_full_version
end

#memcache_nodes ⇒ Array<Google::Apis::MemcacheV1::Node>

Output only. List of Memcached nodes. Refer to Node message for more details. Corresponds to the JSON property memcacheNodes

Returns:



791
792
793
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 791

def memcache_nodes
  @memcache_nodes
end

#memcache_version ⇒ String

The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Corresponds to the JSON property memcacheVersion

Returns:

  • (String) 


799
800
801
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 799

def memcache_version
  @memcache_version
end

#name ⇒ String

Required. Unique name of the resource in this scope including project and location using the form: projects/project_id/locations/location_id/ instances/instance_id`Note: Memcached instances are managed and addressed at the regional level solocation_idhere refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details. Corresponds to the JSON propertyname`

Returns:

  • (String) 


809
810
811
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 809

def name
  @name
end

#node_config ⇒ Google::Apis::MemcacheV1::NodeConfig

Configuration for a Memcached Node. Corresponds to the JSON property nodeConfig

Returns:



814
815
816
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 814

def node_config
  @node_config
end

#node_count ⇒ Fixnum

Required. Number of nodes in the Memcached instance. Corresponds to the JSON property nodeCount

Returns:

  • (Fixnum) 


819
820
821
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 819

def node_count
  @node_count
end

#parameters ⇒ Google::Apis::MemcacheV1::MemcacheParameters

The unique ID associated with this set of parameters. Users can use this id to determine if the parameters associated with the instance differ from the parameters associated with the nodes. A discrepancy between parameter ids can inform users that they may need to take action to apply parameters on nodes. Corresponds to the JSON property parameters

Returns:



827
828
829
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 827

def parameters
  @parameters
end

#state ⇒ String

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

Returns:

  • (String) 


832
833
834
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 832

def state
  @state
end

#update_time ⇒ String

Output only. The time the instance was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


837
838
839
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 837

def update_time
  @update_time
end

#zones ⇒ Array<String>

Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance. Corresponds to the JSON property zones

Returns:

  • (Array<String>) 


844
845
846
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 844

def zones
  @zones
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 851

def update!(**args)
  @authorized_network = args[:authorized_network] if args.key?(:authorized_network)
  @create_time = args[:create_time] if args.key?(:create_time)
  @discovery_endpoint = args[:discovery_endpoint] if args.key?(:discovery_endpoint)
  @display_name = args[:display_name] if args.key?(:display_name)
  @instance_messages = args[:instance_messages] if args.key?(:instance_messages)
  @labels = args[:labels] if args.key?(:labels)
  @memcache_full_version = args[:memcache_full_version] if args.key?(:memcache_full_version)
  @memcache_nodes = args[:memcache_nodes] if args.key?(:memcache_nodes)
  @memcache_version = args[:memcache_version] if args.key?(:memcache_version)
  @name = args[:name] if args.key?(:name)
  @node_config = args[:node_config] if args.key?(:node_config)
  @node_count = args[:node_count] if args.key?(:node_count)
  @parameters = args[:parameters] if args.key?(:parameters)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
  @zones = args[:zones] if args.key?(:zones)
end