TargetPool class
Represents a Target Pool resource.
Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)
Constructors
- TargetPool()
- TargetPool.fromJson(Map _json)
Properties
- backupPool ↔ String
-
This field is applicable only when the containing target pool is serving a
forwarding rule as the primary pool, and its failoverRatio field is
properly set to a value between
0, 1
. [...]read / write - creationTimestamp ↔ String
-
Output Only
Creation timestamp in RFC3339 text format.read / write - description ↔ String
-
An optional description of this resource. Provide this property when you
create the resource.
read / write
- failoverRatio ↔ double
-
This field is applicable only when the containing target pool is serving a
forwarding rule as the primary pool (i.e., not as a backup pool to some
other target pool). The value of the field must be in
0, 1
. [...]read / write - hashCode → int
-
The hash code for this object. [...]
read-only, inherited
-
healthChecks
↔ List<
String> -
The URL of the HttpHealthCheck resource. A member instance in this pool is
considered healthy if and only if the health checks pass. An empty list
means all member instances will be considered healthy at all times. Only
legacy HttpHealthChecks are supported. Only one health check may be
specified.
read / write
- id ↔ String
-
Output Only
The unique identifier for the resource. This identifier is defined by the server.read / write -
instances
↔ List<
String> -
A list of resource URLs to the virtual machine instances serving this
pool. They must live in zones contained in the same region as this pool.
read / write
- kind ↔ String
-
Output Only
Type of the resource. Always compute#targetPool for target pools.read / write - name ↔ String
-
Name of the resource. Provided by the client when the resource is created.
The name must be 1-63 characters long, and comply with RFC1035.
Specifically, the name must be 1-63 characters long and match the regular
expression
[a-z]([-a-z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.read / write - region ↔ String
-
Output Only
URL of the region where the target pool resides.read / write - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- selfLink ↔ String
-
Output Only
Server-defined URL for the resource.read / write - sessionAffinity ↔ String
-
Session affinity option, must be one of the following values:
NONE: Connections from the same client IP may go to any instance in the
pool.
CLIENT_IP: Connections from the same client IP will go to the same
instance in the pool while that instance remains healthy.
CLIENT_IP_PROTO: Connections from the same client IP with the same IP
protocol will go to the same instance in the pool while that instance
remains healthy.
Possible string values are: [...]
read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, Object> -
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited