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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



901
902
903
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 901

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

Instance Attribute Details

#authorized_networkString

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


803
804
805
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 803

def authorized_network
  @authorized_network
end

#create_timeString

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

Returns:

  • (String)


808
809
810
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 808

def create_time
  @create_time
end

#discovery_endpointString

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

Returns:

  • (String)


813
814
815
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 813

def discovery_endpoint
  @discovery_endpoint
end

#display_nameString

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


819
820
821
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 819

def display_name
  @display_name
end

#instance_messagesArray<Google::Apis::MemcacheV1beta2::InstanceMessage>

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



824
825
826
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 824

def instance_messages
  @instance_messages
end

#labelsHash<String,String>

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


831
832
833
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 831

def labels
  @labels
end

#memcache_full_versionString

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)


839
840
841
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 839

def memcache_full_version
  @memcache_full_version
end

#memcache_nodesArray<Google::Apis::MemcacheV1beta2::Node>

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



845
846
847
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 845

def memcache_nodes
  @memcache_nodes
end

#memcache_versionString

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


854
855
856
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 854

def memcache_version
  @memcache_version
end

#nameString

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)


865
866
867
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 865

def name
  @name
end

#node_configGoogle::Apis::MemcacheV1beta2::NodeConfig

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



870
871
872
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 870

def node_config
  @node_config
end

#node_countFixnum

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

Returns:

  • (Fixnum)


875
876
877
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 875

def node_count
  @node_count
end

#parametersGoogle::Apis::MemcacheV1beta2::MemcacheParameters

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



881
882
883
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 881

def parameters
  @parameters
end

#stateString

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

Returns:

  • (String)


886
887
888
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 886

def state
  @state
end

#update_timeString

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

Returns:

  • (String)


891
892
893
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 891

def update_time
  @update_time
end

#zonesArray<String>

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


899
900
901
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 899

def zones
  @zones
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
# File 'generated/google/apis/memcache_v1beta2/classes.rb', line 906

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