Class: Google::Cloud::Memcache::V1::Instance

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/memcache/v1/cloud_memcache.rb

Defined Under Namespace

Modules: State Classes: InstanceMessage, LabelsEntry, Node, NodeConfig

Instance Attribute Summary collapse

Instance Attribute Details

#authorized_network ⇒ ::String

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

Returns:

  • (::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.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the instance was created.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#discovery_endpoint ⇒ ::String (readonly)

Returns Output only. Endpoint for Discovery API.

Returns:

  • (::String) —

    Output only. Endpoint for Discovery API



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#display_name ⇒ ::String

Returns User provided name for the instance only used for display purposes. Cannot be more than 80 characters.

Returns:

  • (::String) —

    User provided name for the instance only used for display purposes. Cannot be more than 80 characters.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#instance_messages ⇒ ::Array<::Google::Cloud::Memcache::V1::Instance::InstanceMessage>

Returns List of messages that describe current statuses of memcached instance.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

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

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#memcache_full_version ⇒ ::String (readonly)

Returns 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".

Returns:

  • (::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".



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#memcache_nodes ⇒ ::Array<::Google::Cloud::Memcache::V1::Instance::Node> (readonly)

Returns Output only. List of Memcached nodes. Refer to [Node] message for more details.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#memcache_version ⇒ ::Google::Cloud::Memcache::V1::MemcacheVersion

Returns 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.

Returns:

  • (::Google::Cloud::Memcache::V1::MemcacheVersion) —

    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.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#name ⇒ ::String

Returns 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.

Returns:

  • (::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.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#node_config ⇒ ::Google::Cloud::Memcache::V1::Instance::NodeConfig

Returns Required. Configuration for Memcached nodes.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#node_count ⇒ ::Integer

Returns Required. Number of nodes in the Memcached instance.

Returns:

  • (::Integer) —

    Required. Number of nodes in the Memcached instance.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#parameters ⇒ ::Google::Cloud::Memcache::V1::MemcacheParameters

Returns Optional: User defined parameters to apply to the memcached process on each node.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#state ⇒ ::Google::Cloud::Memcache::V1::Instance::State (readonly)

Returns Output only. The state of this Memcached instance.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the instance was updated.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end

#zones ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::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.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'proto_docs/google/cloud/memcache/v1/cloud_memcache.rb', line 97

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for a Memcached Node.
  # @!attribute [rw] cpu_count
  #   @return [::Integer]
  #     Required. Number of cpus per Memcached node.
  # @!attribute [rw] memory_size_mb
  #   @return [::Integer]
  #     Required. Memory size in MiB for each Memcached node.
  class NodeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [r] node_id
  #   @return [::String]
  #     Output only. Identifier of the Memcached node. The node id does not
  #     include project or location like the Memcached instance name.
  # @!attribute [r] zone
  #   @return [::String]
  #     Output only. Location (GCP Zone) for the Memcached node.
  # @!attribute [r] state
  #   @return [::Google::Cloud::Memcache::V1::Instance::Node::State]
  #     Output only. Current state of the Memcached node.
  # @!attribute [r] host
  #   @return [::String]
  #     Output only. Hostname or IP address of the Memcached node used by the
  #     clients to connect to the Memcached server on this node.
  # @!attribute [r] port
  #   @return [::Integer]
  #     Output only. The port number of the Memcached server on this node.
  # @!attribute [rw] parameters
  #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
  #     User defined parameters currently applied to the node.
  class Node
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Different states of a Memcached node.
    module State
      # Node state is not set.
      STATE_UNSPECIFIED = 0

      # Node is being created.
      CREATING = 1

      # Node has been created and ready to be used.
      READY = 2

      # Node is being deleted.
      DELETING = 3

      # Node is being updated.
      UPDATING = 4
    end
  end

  # @!attribute [rw] code
  #   @return [::Google::Cloud::Memcache::V1::Instance::InstanceMessage::Code]
  #     A code that correspond to one type of user-facing message.
  # @!attribute [rw] message
  #   @return [::String]
  #     Message on memcached instance which will be exposed to users.
  class InstanceMessage
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    module Code
      # Message Code not set.
      CODE_UNSPECIFIED = 0

      # Memcached nodes are distributed unevenly.
      ZONE_DISTRIBUTION_UNBALANCED = 1
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Different states of a Memcached instance.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Memcached instance is being created.
    CREATING = 1

    # Memcached instance has been created and ready to be used.
    READY = 2

    # Memcached instance is being deleted.
    DELETING = 4

    # Memcached instance is going through maintenance, e.g. data plane rollout.
    PERFORMING_MAINTENANCE = 5
  end
end