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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



775
776
777
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 775

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) 


681
682
683
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 681

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) 


686
687
688
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 686

def create_time
  @create_time
end

#discovery_endpoint ⇒ String

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

Returns:

  • (String) 


691
692
693
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 691

def discovery_endpoint
  @discovery_endpoint
end

#display_name ⇒ String

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

Returns:

  • (String) 


697
698
699
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 697

def display_name
  @display_name
end

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

List of messages that describe current statuses of memcached instance. Corresponds to the JSON property instanceMessages

Returns:



702
703
704
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 702

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


709
710
711
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 709

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) 


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

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:



722
723
724
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 722

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) 


730
731
732
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 730

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 regional level so location_id here refers to a GCP region; however, users may choose which zones Memcached nodes within an instances should be provisioned in. Refer to [zones] field for more details. Corresponds to the JSON propertyname`

Returns:

  • (String) 


740
741
742
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 740

def name
  @name
end

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

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

Returns:



745
746
747
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 745

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) 


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

def node_count
  @node_count
end

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

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

Returns:



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

def parameters
  @parameters
end

#state ⇒ String

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

Returns:

  • (String) 


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

def state
  @state
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

def update_time
  @update_time
end

#zones ⇒ Array<String>

Zones where Memcached nodes should be provisioned in. 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>) 


773
774
775
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 773

def zones
  @zones
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/google/apis/memcache_v1/classes.rb', line 780

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