Console
    Start free

    Compute V1 Client - Class TargetInstance (1.5.0)

    Reference documentation and code samples for the Compute V1 Client class TargetInstance.

    Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances.

    Generated from protobuf message google.cloud.compute.v1.TargetInstance

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ creation_timestamp
    string

    [Output Only] Creation timestamp in RFC3339 text format.

    ↳ description
    string

    An optional description of this resource. Provide this property when you create the resource.

    ↳ id
    int|string

    [Output Only] The unique identifier for the resource. This identifier is defined by the server.

    ↳ instance
    string

    A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance

    ↳ kind
    string

    [Output Only] The type of the resource. Always compute#targetInstance for target instances.

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

    ↳ nat_policy
    string

    Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance. Check the NatPolicy enum for the list of possible values.

    ↳ network
    string

    The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.

    ↳ self_link
    string

    [Output Only] Server-defined URL for the resource.

    ↳ zone
    string

    [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    getCreationTimestamp

    [Output Only] Creation timestamp in RFC3339 text format.

    Generated from protobuf field optional string creation_timestamp = 30525366;

    Returns
    Type
    Description
    string

    hasCreationTimestamp

    clearCreationTimestamp

    setCreationTimestamp

    [Output Only] Creation timestamp in RFC3339 text format.

    Generated from protobuf field optional string creation_timestamp = 30525366;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    An optional description of this resource. Provide this property when you create the resource.

    Generated from protobuf field optional string description = 422937596;

    Returns
    Type
    Description
    string

    hasDescription

    clearDescription

    setDescription

    An optional description of this resource. Provide this property when you create the resource.

    Generated from protobuf field optional string description = 422937596;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getId

    [Output Only] The unique identifier for the resource. This identifier is defined by the server.

    Generated from protobuf field optional uint64 id = 3355;

    Returns
    Type
    Description
    int|string

    hasId

    clearId

    setId

    [Output Only] The unique identifier for the resource. This identifier is defined by the server.

    Generated from protobuf field optional uint64 id = 3355;

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getInstance

    A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance

    Generated from protobuf field optional string instance = 18257045;

    Returns
    Type
    Description
    string

    hasInstance

    clearInstance

    setInstance

    A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance

    Generated from protobuf field optional string instance = 18257045;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getKind

    [Output Only] The type of the resource. Always compute#targetInstance for target instances.

    Generated from protobuf field optional string kind = 3292052;

    Returns
    Type
    Description
    string

    hasKind

    clearKind

    setKind

    [Output Only] The type of the resource. Always compute#targetInstance for target instances.

    Generated from protobuf field optional string kind = 3292052;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getName

    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.

    Generated from protobuf field optional string name = 3373707;

    Returns
    Type
    Description
    string

    hasName

    clearName

    setName

    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.

    Generated from protobuf field optional string name = 3373707;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getNatPolicy

    Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.

    Check the NatPolicy enum for the list of possible values.

    Generated from protobuf field optional string nat_policy = 509780496;

    Returns
    Type
    Description
    string

    hasNatPolicy

    clearNatPolicy

    setNatPolicy

    Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.

    Check the NatPolicy enum for the list of possible values.

    Generated from protobuf field optional string nat_policy = 509780496;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getNetwork

    The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.

    Generated from protobuf field optional string network = 232872494;

    Returns
    Type
    Description
    string

    hasNetwork

    clearNetwork

    setNetwork

    The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.

    Generated from protobuf field optional string network = 232872494;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSelfLink

    [Output Only] Server-defined URL for the resource.

    Generated from protobuf field optional string self_link = 456214797;

    Returns
    Type
    Description
    string

    hasSelfLink

    clearSelfLink

    setSelfLink

    [Output Only] Server-defined URL for the resource.

    Generated from protobuf field optional string self_link = 456214797;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getZone

    [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    Generated from protobuf field optional string zone = 3744684;

    Returns
    Type
    Description
    string

    hasZone

    clearZone

    setZone

    [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    Generated from protobuf field optional string zone = 3744684;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: