Class: Google::Apis::MemcacheV1beta2::Instance

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/memcache_v1beta2/classes.rb,
lib/google/apis/memcache_v1beta2/representations.rb,
lib/google/apis/memcache_v1beta2/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.



806
807
808
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 806

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) 


707
708
709
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 707

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) 


712
713
714
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 712

def create_time
  @create_time
end

#discovery_endpoint ⇒ String

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

Returns:

  • (String) 


717
718
719
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 717

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) 


723
724
725
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 723

def display_name
  @display_name
end

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

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

Returns:



728
729
730
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 728

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>) 


735
736
737
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 735

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) 


743
744
745
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 743

def memcache_full_version
  @memcache_full_version
end

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

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

Returns:



748
749
750
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 748

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) 


756
757
758
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 756

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) 


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

def name
  @name
end

#node_config ⇒ Google::Apis::MemcacheV1beta2::NodeConfig

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

Returns:



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

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) 


776
777
778
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 776

def node_count
  @node_count
end

#parameters ⇒ Google::Apis::MemcacheV1beta2::MemcacheParameters

User defined parameters to apply to the memcached process on each node. Corresponds to the JSON property parameters

Returns:



781
782
783
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 781

def parameters
  @parameters
end

#state ⇒ String

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

Returns:

  • (String) 


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

def state
  @state
end

#update_available ⇒ Boolean Also known as: update_available?

Output only. Returns true if there is an update waiting to be applied Corresponds to the JSON property updateAvailable

Returns:

  • (Boolean) 


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

def update_available
  @update_available
end

#update_time ⇒ String

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

Returns:

  • (String) 


797
798
799
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 797

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>) 


804
805
806
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 804

def zones
  @zones
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/google/apis/memcache_v1beta2/classes.rb', line 811

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_available = args[:update_available] if args.key?(:update_available)
  @update_time = args[:update_time] if args.key?(:update_time)
  @zones = args[:zones] if args.key?(:zones)
end