Console
    Contact Us Start free

    Compute V1 Client - Class ServiceAttachment (1.5.0)

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

    Represents a ServiceAttachment resource. A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service. next tag = 20

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

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ connected_endpoints
    array< Google\Cloud\Compute\V1\ServiceAttachmentConnectedEndpoint >

    [Output Only] An array of connections for all the consumers connected to this service attachment.

    ↳ connection_preference
    string

    The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules. Check the ConnectionPreference enum for the list of possible values.

    ↳ consumer_accept_lists
    array< Google\Cloud\Compute\V1\ServiceAttachmentConsumerProjectLimit >

    Projects that are allowed to connect to this service attachment.

    ↳ consumer_reject_lists
    array

    Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.

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

    ↳ domain_names
    array

    If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1.

    ↳ enable_proxy_protocol
    bool

    If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

    ↳ fingerprint
    string

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

    ↳ id
    int|string

    [Output Only] The unique identifier for the resource type. The server generates this identifier.

    ↳ kind
    string

    [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

    ↳ 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_subnets
    array

    An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

    ↳ producer_forwarding_rule
    string

    The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

    ↳ psc_service_attachment_id
    Google\Cloud\Compute\V1\Uint128

    [Output Only] An 128-bit global unique ID of the PSC service attachment.

    ↳ region
    string

    [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. 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.

    ↳ target_service
    string

    The URL of a service serving the endpoint identified by this service attachment.

    getConnectedEndpoints

    [Output Only] An array of connections for all the consumers connected to this service attachment.

    Generated from protobuf field repeated .google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint connected_endpoints = 72223688;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setConnectedEndpoints

    [Output Only] An array of connections for all the consumers connected to this service attachment.

    Generated from protobuf field repeated .google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint connected_endpoints = 72223688;

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

    getConnectionPreference

    The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.

    Check the ConnectionPreference enum for the list of possible values.

    Generated from protobuf field optional string connection_preference = 285818076;

    Returns
    Type
    Description
    string

    hasConnectionPreference

    clearConnectionPreference

    setConnectionPreference

    The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.

    Check the ConnectionPreference enum for the list of possible values.

    Generated from protobuf field optional string connection_preference = 285818076;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getConsumerAcceptLists

    Projects that are allowed to connect to this service attachment.

    Generated from protobuf field repeated .google.cloud.compute.v1.ServiceAttachmentConsumerProjectLimit consumer_accept_lists = 402725703;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setConsumerAcceptLists

    Projects that are allowed to connect to this service attachment.

    Generated from protobuf field repeated .google.cloud.compute.v1.ServiceAttachmentConsumerProjectLimit consumer_accept_lists = 402725703;

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

    getConsumerRejectLists

    Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.

    Generated from protobuf field repeated string consumer_reject_lists = 204033182;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setConsumerRejectLists

    Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.

    Generated from protobuf field repeated string consumer_reject_lists = 204033182;

    Parameter
    Name
    Description
    var
    string[]
    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

    getDomainNames

    If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1.

    Generated from protobuf field repeated string domain_names = 6450189;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setDomainNames

    If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1.

    Generated from protobuf field repeated string domain_names = 6450189;

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getEnableProxyProtocol

    If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

    Generated from protobuf field optional bool enable_proxy_protocol = 363791237;

    Returns
    Type
    Description
    bool

    hasEnableProxyProtocol

    clearEnableProxyProtocol

    setEnableProxyProtocol

    If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

    Generated from protobuf field optional bool enable_proxy_protocol = 363791237;

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getFingerprint

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

    Generated from protobuf field optional string fingerprint = 234678500;

    Returns
    Type
    Description
    string

    hasFingerprint

    clearFingerprint

    setFingerprint

    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

    Generated from protobuf field optional string fingerprint = 234678500;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getId

    [Output Only] The unique identifier for the resource type. The server generates this identifier.

    Generated from protobuf field optional uint64 id = 3355;

    Returns
    Type
    Description
    int|string

    hasId

    clearId

    setId

    [Output Only] The unique identifier for the resource type. The server generates this identifier.

    Generated from protobuf field optional uint64 id = 3355;

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

    getKind

    [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

    Generated from protobuf field optional string kind = 3292052;

    Returns
    Type
    Description
    string

    hasKind

    clearKind

    setKind

    [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

    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

    getNatSubnets

    An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

    Generated from protobuf field repeated string nat_subnets = 374785944;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setNatSubnets

    An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

    Generated from protobuf field repeated string nat_subnets = 374785944;

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getProducerForwardingRule

    The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

    Generated from protobuf field optional string producer_forwarding_rule = 247927889;

    Returns
    Type
    Description
    string

    hasProducerForwardingRule

    clearProducerForwardingRule

    setProducerForwardingRule

    The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

    Generated from protobuf field optional string producer_forwarding_rule = 247927889;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPscServiceAttachmentId

    [Output Only] An 128-bit global unique ID of the PSC service attachment.

    Generated from protobuf field optional .google.cloud.compute.v1.Uint128 psc_service_attachment_id = 527695214;

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

    hasPscServiceAttachmentId

    clearPscServiceAttachmentId

    setPscServiceAttachmentId

    [Output Only] An 128-bit global unique ID of the PSC service attachment.

    Generated from protobuf field optional .google.cloud.compute.v1.Uint128 psc_service_attachment_id = 527695214;

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

    getRegion

    [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. 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] URL of the region where the service attachment resides. This field applies only to the region resource. 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

    getTargetService

    The URL of a service serving the endpoint identified by this service attachment.

    Generated from protobuf field optional string target_service = 1293831;

    Returns
    Type
    Description
    string

    hasTargetService

    clearTargetService

    setTargetService

    The URL of a service serving the endpoint identified by this service attachment.

    Generated from protobuf field optional string target_service = 1293831;

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