Interface ServiceAttachmentOrBuilder (1.65.0) 

public interface ServiceAttachmentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConnectedEndpoints(int index)

public abstract ServiceAttachmentConnectedEndpoint getConnectedEndpoints(int index)

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

repeated .google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint connected_endpoints = 72223688;

Parameter
Name Description
index int
Returns
Type Description
ServiceAttachmentConnectedEndpoint

getConnectedEndpointsCount()

public abstract int getConnectedEndpointsCount()

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

repeated .google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint connected_endpoints = 72223688;

Returns
Type Description
int

getConnectedEndpointsList()

public abstract List<ServiceAttachmentConnectedEndpoint> getConnectedEndpointsList()

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

repeated .google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint connected_endpoints = 72223688;

Returns
Type Description
List<ServiceAttachmentConnectedEndpoint>

getConnectedEndpointsOrBuilder(int index)

public abstract ServiceAttachmentConnectedEndpointOrBuilder getConnectedEndpointsOrBuilder(int index)

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

repeated .google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint connected_endpoints = 72223688;

Parameter
Name Description
index int
Returns
Type Description
ServiceAttachmentConnectedEndpointOrBuilder

getConnectedEndpointsOrBuilderList()

public abstract List<? extends ServiceAttachmentConnectedEndpointOrBuilder> getConnectedEndpointsOrBuilderList()

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

repeated .google.cloud.compute.v1.ServiceAttachmentConnectedEndpoint connected_endpoints = 72223688;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.ServiceAttachmentConnectedEndpointOrBuilder>

getConnectionPreference()

public abstract 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. Check the ConnectionPreference enum for the list of possible values.

optional string connection_preference = 285818076;

Returns
Type Description
String

The connectionPreference.

getConnectionPreferenceBytes()

public abstract ByteString getConnectionPreferenceBytes()

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.

optional string connection_preference = 285818076;

Returns
Type Description
ByteString

The bytes for connectionPreference.

getConsumerAcceptLists(int index)

public abstract ServiceAttachmentConsumerProjectLimit getConsumerAcceptLists(int index)

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.

repeated .google.cloud.compute.v1.ServiceAttachmentConsumerProjectLimit consumer_accept_lists = 402725703;

Parameter
Name Description
index int
Returns
Type Description
ServiceAttachmentConsumerProjectLimit

getConsumerAcceptListsCount()

public abstract int getConsumerAcceptListsCount()

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.

repeated .google.cloud.compute.v1.ServiceAttachmentConsumerProjectLimit consumer_accept_lists = 402725703;

Returns
Type Description
int

getConsumerAcceptListsList()

public abstract List<ServiceAttachmentConsumerProjectLimit> getConsumerAcceptListsList()

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.

repeated .google.cloud.compute.v1.ServiceAttachmentConsumerProjectLimit consumer_accept_lists = 402725703;

Returns
Type Description
List<ServiceAttachmentConsumerProjectLimit>

getConsumerAcceptListsOrBuilder(int index)

public abstract ServiceAttachmentConsumerProjectLimitOrBuilder getConsumerAcceptListsOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.ServiceAttachmentConsumerProjectLimit consumer_accept_lists = 402725703;

Parameter
Name Description
index int
Returns
Type Description
ServiceAttachmentConsumerProjectLimitOrBuilder

getConsumerAcceptListsOrBuilderList()

public abstract List<? extends ServiceAttachmentConsumerProjectLimitOrBuilder> getConsumerAcceptListsOrBuilderList()

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.

repeated .google.cloud.compute.v1.ServiceAttachmentConsumerProjectLimit consumer_accept_lists = 402725703;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.ServiceAttachmentConsumerProjectLimitOrBuilder>

getConsumerRejectLists(int index)

public abstract String getConsumerRejectLists(int index)

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.

repeated string consumer_reject_lists = 204033182;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The consumerRejectLists at the given index.

getConsumerRejectListsBytes(int index)

public abstract ByteString getConsumerRejectListsBytes(int index)

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.

repeated string consumer_reject_lists = 204033182;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the consumerRejectLists at the given index.

getConsumerRejectListsCount()

public abstract int getConsumerRejectListsCount()

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.

repeated string consumer_reject_lists = 204033182;

Returns
Type Description
int

The count of consumerRejectLists.

getConsumerRejectListsList()

public abstract List<String> getConsumerRejectListsList()

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.

repeated string consumer_reject_lists = 204033182;

Returns
Type Description
List<String>

A list containing the consumerRejectLists.

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDescription()

public abstract String getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDomainNames(int index)

public abstract String getDomainNames(int index)

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.

repeated string domain_names = 6450189;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The domainNames at the given index.

getDomainNamesBytes(int index)

public abstract ByteString getDomainNamesBytes(int index)

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.

repeated string domain_names = 6450189;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the domainNames at the given index.

getDomainNamesCount()

public abstract int getDomainNamesCount()

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.

repeated string domain_names = 6450189;

Returns
Type Description
int

The count of domainNames.

getDomainNamesList()

public abstract List<String> getDomainNamesList()

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.

repeated string domain_names = 6450189;

Returns
Type Description
List<String>

A list containing the domainNames.

getEnableProxyProtocol()

public abstract 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.

optional bool enable_proxy_protocol = 363791237;

Returns
Type Description
boolean

The enableProxyProtocol.

getFingerprint()

public abstract 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.

optional string fingerprint = 234678500;

Returns
Type Description
String

The fingerprint.

getFingerprintBytes()

public abstract ByteString getFingerprintBytes()

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.

optional string fingerprint = 234678500;

Returns
Type Description
ByteString

The bytes for fingerprint.

getId()

public abstract long getId()

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

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public abstract String getKind()

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public abstract 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? 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.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getNatSubnets(int index)

public abstract String getNatSubnets(int index)

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.

repeated string nat_subnets = 374785944;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The natSubnets at the given index.

getNatSubnetsBytes(int index)

public abstract ByteString getNatSubnetsBytes(int index)

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.

repeated string nat_subnets = 374785944;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the natSubnets at the given index.

getNatSubnetsCount()

public abstract int getNatSubnetsCount()

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.

repeated string nat_subnets = 374785944;

Returns
Type Description
int

The count of natSubnets.

getNatSubnetsList()

public abstract List<String> getNatSubnetsList()

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.

repeated string nat_subnets = 374785944;

Returns
Type Description
List<String>

A list containing the natSubnets.

getProducerForwardingRule()

public abstract String getProducerForwardingRule()

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

optional string producer_forwarding_rule = 247927889;

Returns
Type Description
String

The producerForwardingRule.

getProducerForwardingRuleBytes()

public abstract ByteString getProducerForwardingRuleBytes()

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

optional string producer_forwarding_rule = 247927889;

Returns
Type Description
ByteString

The bytes for producerForwardingRule.

getPropagatedConnectionLimit()

public abstract int 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.

optional uint32 propagated_connection_limit = 332719230;

Returns
Type Description
int

The propagatedConnectionLimit.

getPscServiceAttachmentId()

public abstract Uint128 getPscServiceAttachmentId()

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

optional .google.cloud.compute.v1.Uint128 psc_service_attachment_id = 527695214;

Returns
Type Description
Uint128

The pscServiceAttachmentId.

getPscServiceAttachmentIdOrBuilder()

public abstract Uint128OrBuilder getPscServiceAttachmentIdOrBuilder()

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

optional .google.cloud.compute.v1.Uint128 psc_service_attachment_id = 527695214;

Returns
Type Description
Uint128OrBuilder

getReconcileConnections()

public abstract 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.

optional bool reconcile_connections = 125493732;

Returns
Type Description
boolean

The reconcileConnections.

getRegion()

public abstract 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.

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public abstract ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

getSelfLink()

public abstract String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getTargetService()

public abstract String getTargetService()

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

optional string target_service = 1293831;

Returns
Type Description
String

The targetService.

getTargetServiceBytes()

public abstract ByteString getTargetServiceBytes()

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

optional string target_service = 1293831;

Returns
Type Description
ByteString

The bytes for targetService.

hasConnectionPreference()

public abstract boolean hasConnectionPreference()

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.

optional string connection_preference = 285818076;

Returns
Type Description
boolean

Whether the connectionPreference field is set.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public abstract boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasEnableProxyProtocol()

public abstract boolean hasEnableProxyProtocol()

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.

optional bool enable_proxy_protocol = 363791237;

Returns
Type Description
boolean

Whether the enableProxyProtocol field is set.

hasFingerprint()

public abstract boolean hasFingerprint()

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.

optional string fingerprint = 234678500;

Returns
Type Description
boolean

Whether the fingerprint field is set.

hasId()

public abstract boolean hasId()

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

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public abstract boolean hasKind()

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

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public abstract boolean hasName()

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

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasProducerForwardingRule()

public abstract boolean hasProducerForwardingRule()

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

optional string producer_forwarding_rule = 247927889;

Returns
Type Description
boolean

Whether the producerForwardingRule field is set.

hasPropagatedConnectionLimit()

public abstract boolean hasPropagatedConnectionLimit()

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.

optional uint32 propagated_connection_limit = 332719230;

Returns
Type Description
boolean

Whether the propagatedConnectionLimit field is set.

hasPscServiceAttachmentId()

public abstract boolean hasPscServiceAttachmentId()

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

optional .google.cloud.compute.v1.Uint128 psc_service_attachment_id = 527695214;

Returns
Type Description
boolean

Whether the pscServiceAttachmentId field is set.

hasReconcileConnections()

public abstract boolean hasReconcileConnections()

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.

optional bool reconcile_connections = 125493732;

Returns
Type Description
boolean

Whether the reconcileConnections field is set.

hasRegion()

public abstract boolean hasRegion()

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

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

hasSelfLink()

public abstract boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasTargetService()

public abstract boolean hasTargetService()

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

optional string target_service = 1293831;

Returns
Type Description
boolean

Whether the targetService field is set.