Console
    Start free

    Compute V1 Client - Class Router (1.5.0)

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

    Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

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

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ bgp
    Google\Cloud\Compute\V1\RouterBgp

    BGP information specific to this router.

    ↳ bgp_peers
    array< Google\Cloud\Compute\V1\RouterBgpPeer >

    BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

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

    ↳ encrypted_interconnect_router
    bool

    Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).

    ↳ id
    int|string

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

    ↳ interfaces
    array< Google\Cloud\Compute\V1\RouterInterface >

    Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

    ↳ kind
    string

    [Output Only] Type of resource. Always compute#router for routers.

    ↳ md5_authentication_keys
    array< Google\Cloud\Compute\V1\RouterMd5AuthenticationKey >

    Keys used for MD5 authentication.

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

    ↳ nats
    array< Google\Cloud\Compute\V1\RouterNat >

    A list of NAT services created in this router.

    ↳ network
    string

    URI of the network to which this router belongs.

    ↳ region
    string

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

    ↳ self_link
    string

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

    getBgp

    BGP information specific to this router.

    Generated from protobuf field optional .google.cloud.compute.v1.RouterBgp bgp = 97483;

    Returns
    Type
    Description
    Google\Cloud\Compute\V1\RouterBgp |null

    hasBgp

    clearBgp

    setBgp

    BGP information specific to this router.

    Generated from protobuf field optional .google.cloud.compute.v1.RouterBgp bgp = 97483;

    Parameter
    Name
    Description
    var
    Google\Cloud\Compute\V1\RouterBgp
    Returns
    Type
    Description
    $this

    getBgpPeers

    BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

    Generated from protobuf field repeated .google.cloud.compute.v1.RouterBgpPeer bgp_peers = 452695773;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setBgpPeers

    BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

    Generated from protobuf field repeated .google.cloud.compute.v1.RouterBgpPeer bgp_peers = 452695773;

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Compute\V1\RouterBgpPeer >
    Returns
    Type
    Description
    $this

    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

    getEncryptedInterconnectRouter

    Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).

    Generated from protobuf field optional bool encrypted_interconnect_router = 297996575;

    Returns
    Type
    Description
    bool

    hasEncryptedInterconnectRouter

    clearEncryptedInterconnectRouter

    setEncryptedInterconnectRouter

    Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).

    Generated from protobuf field optional bool encrypted_interconnect_router = 297996575;

    Parameter
    Name
    Description
    var
    bool
    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

    getInterfaces

    Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

    Generated from protobuf field repeated .google.cloud.compute.v1.RouterInterface interfaces = 12073562;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setInterfaces

    Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

    Generated from protobuf field repeated .google.cloud.compute.v1.RouterInterface interfaces = 12073562;

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Compute\V1\RouterInterface >
    Returns
    Type
    Description
    $this

    getKind

    [Output Only] Type of resource. Always compute#router for routers.

    Generated from protobuf field optional string kind = 3292052;

    Returns
    Type
    Description
    string

    hasKind

    clearKind

    setKind

    [Output Only] Type of resource. Always compute#router for routers.

    Generated from protobuf field optional string kind = 3292052;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getMd5AuthenticationKeys

    Keys used for MD5 authentication.

    Generated from protobuf field repeated .google.cloud.compute.v1.RouterMd5AuthenticationKey md5_authentication_keys = 71063322;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setMd5AuthenticationKeys

    Keys used for MD5 authentication.

    Generated from protobuf field repeated .google.cloud.compute.v1.RouterMd5AuthenticationKey md5_authentication_keys = 71063322;

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Compute\V1\RouterMd5AuthenticationKey >
    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

    getNats

    A list of NAT services created in this router.

    Generated from protobuf field repeated .google.cloud.compute.v1.RouterNat nats = 3373938;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setNats

    A list of NAT services created in this router.

    Generated from protobuf field repeated .google.cloud.compute.v1.RouterNat nats = 3373938;

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Compute\V1\RouterNat >
    Returns
    Type
    Description
    $this

    getNetwork

    URI of the network to which this router belongs.

    Generated from protobuf field optional string network = 232872494;

    Returns
    Type
    Description
    string

    hasNetwork

    clearNetwork

    setNetwork

    URI of the network to which this router belongs.

    Generated from protobuf field optional string network = 232872494;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRegion

    [Output Only] URI of the region where the router 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 region = 138946292;

    Returns
    Type
    Description
    string

    hasRegion

    clearRegion

    setRegion

    [Output Only] URI of the region where the router 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 region = 138946292;

    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
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: