• Home
• com.google.apis
• google-api-services-compute
• v1-rev20250320-2.0.0
• source code
• ServiceAttachment.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.compute.model.ServiceAttachment.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class ServiceAttachment



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.ServiceAttachment













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class ServiceAttachment
extends com.google.api.client.json.GenericJson
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.

 
 This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


ServiceAttachment() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


ServiceAttachment
clone() 


byte[]
decodeFingerprint()
Fingerprint of this resource.



ServiceAttachment
encodeFingerprint(byte[] fingerprint)
Fingerprint of this resource.



List<ServiceAttachmentConnectedEndpoint>
getConnectedEndpoints()
[Output Only] An array of connections for all the consumers connected to this service
 attachment.



String
getConnectionPreference()
The connection preference of service attachment.



List<ServiceAttachmentConsumerProjectLimit>
getConsumerAcceptLists()
Specifies which consumer projects or networks are allowed to connect to the service attachment.



List<String>
getConsumerRejectLists()
Specifies a list of projects or networks that are not allowed to connect to this service
 attachment.



String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.



String
getDescription()
An optional description of this resource.



List<String>
getDomainNames()
If specified, the domain name will be used during the integration between the PSC connected
 endpoints and the Cloud DNS.



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



String
getFingerprint()
Fingerprint of this resource.



BigInteger
getId()
[Output Only] The unique identifier for the resource type.



String
getKind()
[Output Only] Type of the resource.



String
getName()
Name of the resource.



List<String>
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.



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



Long
getPropagatedConnectionLimit()
The number of consumer spokes that connected Private Service Connect endpoints can be
 propagated to through Network Connectivity Center.



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



Boolean
getReconcileConnections()
This flag determines whether a consumer accept/reject list change can reconcile the statuses of
 existing ACCEPTED or REJECTED PSC endpoints.



String
getRegion()
[Output Only] URL of the region where the service attachment resides.



String
getSelfLink()
[Output Only] Server-defined URL for the resource.



String
getTargetService()
The URL of a service serving the endpoint identified by this service attachment.



ServiceAttachment
set(String fieldName,
   Object value) 


ServiceAttachment
setConnectedEndpoints(List<ServiceAttachmentConnectedEndpoint> connectedEndpoints)
[Output Only] An array of connections for all the consumers connected to this service
 attachment.



ServiceAttachment
setConnectionPreference(String connectionPreference)
The connection preference of service attachment.



ServiceAttachment
setConsumerAcceptLists(List<ServiceAttachmentConsumerProjectLimit> consumerAcceptLists)
Specifies which consumer projects or networks are allowed to connect to the service attachment.



ServiceAttachment
setConsumerRejectLists(List<String> consumerRejectLists)
Specifies a list of projects or networks that are not allowed to connect to this service
 attachment.



ServiceAttachment
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.



ServiceAttachment
setDescription(String description)
An optional description of this resource.



ServiceAttachment
setDomainNames(List<String> domainNames)
If specified, the domain name will be used during the integration between the PSC connected
 endpoints and the Cloud DNS.



ServiceAttachment
setEnableProxyProtocol(Boolean enableProxyProtocol)
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.



ServiceAttachment
setFingerprint(String fingerprint)
Fingerprint of this resource.



ServiceAttachment
setId(BigInteger id)
[Output Only] The unique identifier for the resource type.



ServiceAttachment
setKind(String kind)
[Output Only] Type of the resource.



ServiceAttachment
setName(String name)
Name of the resource.



ServiceAttachment
setNatSubnets(List<String> natSubnets)
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.



ServiceAttachment
setProducerForwardingRule(String producerForwardingRule)
The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint
 identified by this service attachment.



ServiceAttachment
setPropagatedConnectionLimit(Long propagatedConnectionLimit)
The number of consumer spokes that connected Private Service Connect endpoints can be
 propagated to through Network Connectivity Center.



ServiceAttachment
setPscServiceAttachmentId(Uint128 pscServiceAttachmentId)
[Output Only] An 128-bit global unique ID of the PSC service attachment.



ServiceAttachment
setReconcileConnections(Boolean reconcileConnections)
This flag determines whether a consumer accept/reject list change can reconcile the statuses of
 existing ACCEPTED or REJECTED PSC endpoints.



ServiceAttachment
setRegion(String region)
[Output Only] URL of the region where the service attachment resides.



ServiceAttachment
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.



ServiceAttachment
setTargetService(String targetService)
The URL of a service serving the endpoint identified by this service attachment.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





ServiceAttachment
public ServiceAttachment()









Method Detail





getConnectedEndpoints
public List<ServiceAttachmentConnectedEndpoint> getConnectedEndpoints()
[Output Only] An array of connections for all the consumers connected to this service
 attachment.

Returns:
value or null for none








setConnectedEndpoints
public ServiceAttachment setConnectedEndpoints(List<ServiceAttachmentConnectedEndpoint> connectedEndpoints)
[Output Only] An array of connections for all the consumers connected to this service
 attachment.

Parameters:
connectedEndpoints - connectedEndpoints or null for none








getConnectionPreference
public String 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.

Returns:
value or null for none








setConnectionPreference
public ServiceAttachment setConnectionPreference(String connectionPreference)
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.

Parameters:
connectionPreference - connectionPreference or null for none








getConsumerAcceptLists
public List<ServiceAttachmentConsumerProjectLimit> getConsumerAcceptLists()
Specifies which consumer projects or networks are allowed to connect to the service attachment.
 Each project or network has a connection limit. A given service attachment can manage
 connections at either the project or network level. Therefore, both the accept and reject lists
 for a given service attachment must contain either only projects or only networks.

Returns:
value or null for none








setConsumerAcceptLists
public ServiceAttachment setConsumerAcceptLists(List<ServiceAttachmentConsumerProjectLimit> consumerAcceptLists)
Specifies which consumer projects or networks are allowed to connect to the service attachment.
 Each project or network has a connection limit. A given service attachment can manage
 connections at either the project or network level. Therefore, both the accept and reject lists
 for a given service attachment must contain either only projects or only networks.

Parameters:
consumerAcceptLists - consumerAcceptLists or null for none








getConsumerRejectLists
public List<String> getConsumerRejectLists()
Specifies a list of projects or networks that are not allowed to connect to this service
 attachment. The project can be specified using its project ID or project number and the network
 can be specified using its URL. A given service attachment can manage connections at either the
 project or network level. Therefore, both the reject and accept lists for a given service
 attachment must contain either only projects or only networks.

Returns:
value or null for none








setConsumerRejectLists
public ServiceAttachment setConsumerRejectLists(List<String> consumerRejectLists)
Specifies a list of projects or networks that are not allowed to connect to this service
 attachment. The project can be specified using its project ID or project number and the network
 can be specified using its URL. A given service attachment can manage connections at either the
 project or network level. Therefore, both the reject and accept lists for a given service
 attachment must contain either only projects or only networks.

Parameters:
consumerRejectLists - consumerRejectLists or null for none








getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public ServiceAttachment setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.

Parameters:
creationTimestamp - creationTimestamp or null for none








getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.

Returns:
value or null for none








setDescription
public ServiceAttachment setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description or null for none








getDomainNames
public List<String> 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.

Returns:
value or null for none








setDomainNames
public ServiceAttachment setDomainNames(List<String> domainNames)
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.

Parameters:
domainNames - domainNames or null for none








getEnableProxyProtocol
public Boolean 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.

Returns:
value or null for none








setEnableProxyProtocol
public ServiceAttachment setEnableProxyProtocol(Boolean enableProxyProtocol)
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.

Parameters:
enableProxyProtocol - enableProxyProtocol or null for none








getFingerprint
public String 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.

Returns:
value or null for none
See Also:
decodeFingerprint()








decodeFingerprint
public byte[] decodeFingerprint()
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.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getFingerprint()








setFingerprint
public ServiceAttachment setFingerprint(String fingerprint)
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.

Parameters:
fingerprint - fingerprint or null for none
See Also:
#encodeFingerprint()








encodeFingerprint
public ServiceAttachment encodeFingerprint(byte[] fingerprint)
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.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getId
public BigInteger getId()
[Output Only] The unique identifier for the resource type. The server generates this
 identifier.

Returns:
value or null for none








setId
public ServiceAttachment setId(BigInteger id)
[Output Only] The unique identifier for the resource type. The server generates this
 identifier.

Parameters:
id - id or null for none








getKind
public String getKind()
[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

Returns:
value or null for none








setKind
public ServiceAttachment setKind(String kind)
[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

Parameters:
kind - kind or null for none








getName
public String 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.

Returns:
value or null for none








setName
public ServiceAttachment setName(String name)
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.

Parameters:
name - name or null for none








getNatSubnets
public List<String> 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.

Returns:
value or null for none








setNatSubnets
public ServiceAttachment setNatSubnets(List<String> natSubnets)
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.

Parameters:
natSubnets - natSubnets or null for none








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

Returns:
value or null for none








setProducerForwardingRule
public ServiceAttachment setProducerForwardingRule(String producerForwardingRule)
The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint
 identified by this service attachment.

Parameters:
producerForwardingRule - producerForwardingRule or null for none








getPropagatedConnectionLimit
public Long getPropagatedConnectionLimit()
The number of consumer spokes that connected Private Service Connect endpoints can be
 propagated to through Network Connectivity Center. This limit lets the service producer limit
 how many propagated Private Service Connect connections can be established to this service
 attachment from a single consumer. If the connection preference of the service attachment is
 ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer
 accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the
 limit applies to each project that contains a connected endpoint. If unspecified, the default
 propagated connection limit is 250.

Returns:
value or null for none








setPropagatedConnectionLimit
public ServiceAttachment setPropagatedConnectionLimit(Long propagatedConnectionLimit)
The number of consumer spokes that connected Private Service Connect endpoints can be
 propagated to through Network Connectivity Center. This limit lets the service producer limit
 how many propagated Private Service Connect connections can be established to this service
 attachment from a single consumer. If the connection preference of the service attachment is
 ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer
 accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the
 limit applies to each project that contains a connected endpoint. If unspecified, the default
 propagated connection limit is 250.

Parameters:
propagatedConnectionLimit - propagatedConnectionLimit or null for none








getPscServiceAttachmentId
public Uint128 getPscServiceAttachmentId()
[Output Only] An 128-bit global unique ID of the PSC service attachment.

Returns:
value or null for none








setPscServiceAttachmentId
public ServiceAttachment setPscServiceAttachmentId(Uint128 pscServiceAttachmentId)
[Output Only] An 128-bit global unique ID of the PSC service attachment.

Parameters:
pscServiceAttachmentId - pscServiceAttachmentId or null for none








getReconcileConnections
public Boolean getReconcileConnections()
This flag determines whether a consumer accept/reject list change can reconcile the statuses of
 existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only
 affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain
 untouched regardless how the connection policy is modified . - If true, update will affect both
 PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be
 moved to REJECTED if its project is added to the reject list. For newly created service
 attachment, this boolean defaults to false.

Returns:
value or null for none








setReconcileConnections
public ServiceAttachment setReconcileConnections(Boolean reconcileConnections)
This flag determines whether a consumer accept/reject list change can reconcile the statuses of
 existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only
 affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain
 untouched regardless how the connection policy is modified . - If true, update will affect both
 PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be
 moved to REJECTED if its project is added to the reject list. For newly created service
 attachment, this boolean defaults to false.

Parameters:
reconcileConnections - reconcileConnections or null for none








getRegion
public String 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.

Returns:
value or null for none








setRegion
public ServiceAttachment setRegion(String region)
[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.

Parameters:
region - region or null for none








getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.

Returns:
value or null for none








setSelfLink
public ServiceAttachment setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getTargetService
public String getTargetService()
The URL of a service serving the endpoint identified by this service attachment.

Returns:
value or null for none








setTargetService
public ServiceAttachment setTargetService(String targetService)
The URL of a service serving the endpoint identified by this service attachment.

Parameters:
targetService - targetService or null for none








set
public ServiceAttachment set(String fieldName,
                             Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public ServiceAttachment clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.