Class: Google::Apis::ComputeV1::ServiceAttachment

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ServiceAttachment

Returns a new instance of ServiceAttachment.



56986
56987
56988
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56986

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#connected_endpoints ⇒ Array<Google::Apis::ComputeV1::ServiceAttachmentConnectedEndpoint>

Output only. [Output Only] An array of connections for all the consumers connected to this service attachment. Corresponds to the JSON property connectedEndpoints

Returns:



56811
56812
56813
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56811

def connected_endpoints
  @connected_endpoints
end

#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. Corresponds to the JSON property connectionPreference

Returns:

  • (String) 


56819
56820
56821
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56819

def connection_preference
  @connection_preference
end

#consumer_accept_lists ⇒ Array<Google::Apis::ComputeV1::ServiceAttachmentConsumerProjectLimit>

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 or only endpoints. Corresponds to the JSON property consumerAcceptLists

Returns:



56829
56830
56831
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56829

def consumer_accept_lists
  @consumer_accept_lists
end

#consumer_reject_lists ⇒ Array<String>

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. Corresponds to the JSON property consumerRejectLists

Returns:

  • (Array<String>) 


56839
56840
56841
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56839

def consumer_reject_lists
  @consumer_reject_lists
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


56845
56846
56847
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56845

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


56851
56852
56853
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56851

def description
  @description
end

#domain_names ⇒ Array<String>

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. Corresponds to the JSON property domainNames

Returns:

  • (Array<String>) 


56859
56860
56861
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56859

def domain_names
  @domain_names
end

#enable_proxy_protocol ⇒ Boolean Also known as: enable_proxy_protocol?

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. Corresponds to the JSON property enableProxyProtocol

Returns:

  • (Boolean) 


56866
56867
56868
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56866

def enable_proxy_protocol
  @enable_proxy_protocol
end

#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. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


56879
56880
56881
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56879

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


56886
56887
56888
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56886

def id
  @id
end

#kind ⇒ String

Output only. [Output Only] Type of the resource. Alwayscompute# serviceAttachment for service attachments. Corresponds to the JSON property kind

Returns:

  • (String) 


56892
56893
56894
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56892

def kind
  @kind
end

#metadata ⇒ Hash<String,String>

Metadata of the service attachment. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


56897
56898
56899
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56897

def metadata
  @metadata
end

#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 withRFC1035. 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. Corresponds to the JSON property name

Returns:

  • (String) 


56908
56909
56910
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56908

def name
  @name
end

#nat_ips_per_endpoint ⇒ Fixnum

The number of NAT IP addresses to be allocated per connected endpoint. If not specified, the default value is 1. Corresponds to the JSON property natIpsPerEndpoint

Returns:

  • (Fixnum) 


56914
56915
56916
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56914

def nat_ips_per_endpoint
  @nat_ips_per_endpoint
end

#nat_subnets ⇒ Array<String>

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. Corresponds to the JSON property natSubnets

Returns:

  • (Array<String>) 


56920
56921
56922
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56920

def nat_subnets
  @nat_subnets
end

#producer_forwarding_rule ⇒ String

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

Returns:

  • (String) 


56926
56927
56928
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56926

def producer_forwarding_rule
  @producer_forwarding_rule
end

#propagated_connection_limit ⇒ Fixnum

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. Corresponds to the JSON property propagatedConnectionLimit

Returns:

  • (Fixnum) 


56941
56942
56943
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56941

def propagated_connection_limit
  @propagated_connection_limit
end

#psc_service_attachment_id ⇒ Google::Apis::ComputeV1::Uint128

Output only. [Output Only] An 128-bit global unique ID of the PSC service attachment. Corresponds to the JSON property pscServiceAttachmentId

Returns:



56947
56948
56949
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56947

def psc_service_attachment_id
  @psc_service_attachment_id
end

#reconcile_connections ⇒ Boolean Also known as: reconcile_connections?

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. Corresponds to the JSON property reconcileConnections

Returns:

  • (Boolean) 


56963
56964
56965
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56963

def reconcile_connections
  @reconcile_connections
end

#region ⇒ String

Output only. [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. Corresponds to the JSON property region

Returns:

  • (String) 


56973
56974
56975
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56973

def region
  @region
end

#self_link ⇒ String

Output only. [Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


56978
56979
56980
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56978

def self_link
  @self_link
end

#target_service ⇒ String

The URL of a service serving the endpoint identified by this service attachment. Corresponds to the JSON property targetService

Returns:

  • (String) 


56984
56985
56986
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56984

def target_service
  @target_service
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



56991
56992
56993
56994
56995
56996
56997
56998
56999
57000
57001
57002
57003
57004
57005
57006
57007
57008
57009
57010
57011
57012
57013
57014
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56991

def update!(**args)
  @connected_endpoints = args[:connected_endpoints] if args.key?(:connected_endpoints)
  @connection_preference = args[:connection_preference] if args.key?(:connection_preference)
  @consumer_accept_lists = args[:consumer_accept_lists] if args.key?(:consumer_accept_lists)
  @consumer_reject_lists = args[:consumer_reject_lists] if args.key?(:consumer_reject_lists)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @domain_names = args[:domain_names] if args.key?(:domain_names)
  @enable_proxy_protocol = args[:enable_proxy_protocol] if args.key?(:enable_proxy_protocol)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @nat_ips_per_endpoint = args[:nat_ips_per_endpoint] if args.key?(:nat_ips_per_endpoint)
  @nat_subnets = args[:nat_subnets] if args.key?(:nat_subnets)
  @producer_forwarding_rule = args[:producer_forwarding_rule] if args.key?(:producer_forwarding_rule)
  @propagated_connection_limit = args[:propagated_connection_limit] if args.key?(:propagated_connection_limit)
  @psc_service_attachment_id = args[:psc_service_attachment_id] if args.key?(:psc_service_attachment_id)
  @reconcile_connections = args[:reconcile_connections] if args.key?(:reconcile_connections)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @target_service = args[:target_service] if args.key?(:target_service)
end