| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.networkEndpointGroups.html">networkEndpointGroups</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the list of network endpoint groups and sorts them by zone.</p> |
| <p class="toc_element"> |
| <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Attach a list of network endpoints to the specified network endpoint group.</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, zone, networkEndpointGroup, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified network endpoint group. The network endpoints in the</p> |
| <p class="toc_element"> |
| <code><a href="#detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Detach a list of network endpoints from the specified network endpoint</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, zone, networkEndpointGroup, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the specified network endpoint group.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a network endpoint group in the specified project using the</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the list of network endpoint groups that are located in the</p> |
| <p class="toc_element"> |
| <code><a href="#listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the network endpoints in the specified network endpoint group.</p> |
| <p class="toc_element"> |
| <code><a href="#listNetworkEndpoints_next">listNetworkEndpoints_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code> |
| <pre>Retrieves the list of network endpoint groups and sorts them by zone. |
| |
| To prevent failure, Google recommends that you set the |
| `returnPartialSuccess` parameter to `true`. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource labels. |
| |
| To filter on multiple expressions, provide each separate expression within |
| parentheses. For example: |
| ``` |
| (scheduling.automaticRestart = true) |
| (cpuPlatform = "Intel Skylake") |
| ``` |
| By default, each expression is an `AND` expression. However, you |
| can include `AND` and `OR` expressions explicitly. |
| For example: |
| ``` |
| (cpuPlatform = "Intel Skylake") OR |
| (cpuPlatform = "Intel Broadwell") AND |
| (scheduling.automaticRestart = true) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, |
| global) should be included in the response. For new resource types added |
| after this field, the flag has no effect as new resource types will always |
| include every visible scope for each scope type in response. For resource |
| types which predate this field, if this flag is omitted or false, only |
| scopes of the scope types where the resource type is expected to be found |
| will be included. |
| maxResults: integer, The maximum number of results per page that should be returned. |
| If the number of available results is larger than `maxResults`, |
| Compute Engine returns a `nextPageToken` that can be used to get |
| the next page of results in subsequent list requests. Acceptable values are |
| `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results |
| are returned in alphanumerical order based on the resource name. |
| |
| You can also sort results in descending order based on the creation |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts |
| results based on the `creationTimestamp` field in |
| reverse chronological order (newest result first). Use this to sort |
| resources like operations so that the newest operation is returned first. |
| |
| Currently, only sorting by `name` or |
| `creationTimestamp desc` is supported. |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the |
| `nextPageToken` returned by a previous list request to get |
| the next page of results. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| serviceProjectNumber: string, The Shared VPC service project id or service project number for which |
| aggregated list request is invoked for subnetworks list-usable api. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": { # A list of NetworkEndpointGroupsScopedList resources. |
| "a_key": { # The name of the scope that contains this set of network endpoint groups. |
| "networkEndpointGroups": [ # [Output Only] The list ofnetwork |
| # endpoint groups that are contained in this scope. |
| { # Represents a collection of network endpoints. |
| # |
| # A network endpoint group (NEG) defines how a set of endpoints should be |
| # reached, whether they are reachable, and where they are located. |
| # For more information about using NEGs for different use cases, seeNetwork endpoint groups overview. |
| "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. |
| "a_key": "A String", |
| }, |
| "appEngine": { # Configuration for an App Engine network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The service is optional, may be provided explicitly or in the |
| # URL mask. The version is optional and can only be provided |
| # explicitly or in the URL mask when service is present. |
| # |
| # Note: App Engine service must be in the same project and located in the |
| # same region as the Serverless NEG. |
| "service": "A String", # Optional serving service. |
| # |
| # The service name is case-sensitive and must be 1-63 |
| # characters long. |
| # |
| # Example value: default, my-service. |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse service and version fields |
| # from a request URL. URL mask allows for routing to multiple App Engine |
| # services without having to create multiple Network Endpoint Groups and |
| # backend services. |
| # |
| # For example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same |
| # Serverless NEG with URL mask<service>-dot-appname.appspot.com/<version>. |
| # The URL mask will parse them to { service = "foo1", version = "v1" |
| # } and { service = "foo1", version = "v2" } |
| # respectively. |
| "version": "A String", # Optional serving version. |
| # |
| # The version name is case-sensitive and must be 1-100 |
| # characters long. |
| # |
| # Example value: v1, v2. |
| }, |
| "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The function must be provided explicitly or in the URL mask. |
| # |
| # Note: Cloud Function must be in the same project and located in the same |
| # region as the Serverless NEG. |
| "function": "A String", # A user-defined name of the Cloud Function. |
| # |
| # The function name is case-sensitive and must be 1-63 |
| # characters long. |
| # |
| # Example value: func1. |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse function field from a request URL. URL |
| # mask allows for routing to multiple Cloud Functions without having to |
| # create multiple Network Endpoint Groups and backend services. |
| # |
| # For example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same |
| # Serverless NEG with URL mask /<function>. The URL |
| # mask will parse them to { function = "function1" } and{ function = "function2" } respectively. |
| }, |
| "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The service must be provided explicitly or in the URL mask. |
| # The tag is optional, may be provided explicitly or in the URL |
| # mask. |
| # |
| # Note: Cloud Run service must be in the same project and located in the same |
| # region as the Serverless NEG. |
| "service": "A String", # Cloud Run service is the main resource of Cloud Run. |
| # |
| # The service must be 1-63 characters long, and comply withRFC1035. |
| # |
| # Example value: "run-service". |
| "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional |
| # fine-grained traffic routing information. |
| # |
| # The tag must be 1-63 characters long, and comply withRFC1035. |
| # |
| # Example value: "revision-0010". |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse <service> and<tag> fields from a request URL. URL mask allows for |
| # routing to multiple Run services without having to create multiple |
| # network endpoint groups and backend services. |
| # |
| # For example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless |
| # Network Endpoint Group (NEG) with URL mask<tag>.domain.com/<service>. The URL mask will |
| # parse them to { service="bar1", tag="foo1" } and { |
| # service="bar2", tag="foo2" } respectively. |
| }, |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "defaultPort": 42, # The default port used if the port number is not specified in the network |
| # endpoint. |
| # |
| # Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this |
| # field must not be specified. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group. |
| "loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load |
| # balancing. |
| # [Deprecated] This field is deprecated. |
| "defaultPort": 42, # The default port used if the port number is not specified in the network |
| # endpoint. |
| # |
| # If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this |
| # field must not be specified. |
| # [Deprecated] This field is deprecated. |
| "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. |
| # Uses default project network if unspecified. |
| # [Deprecated] This field is deprecated. |
| "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG |
| # belong. |
| # [Deprecated] This field is deprecated. |
| "zone": "A String", # [Output Only] The URL of thezone |
| # where the network endpoint group is located. |
| # [Deprecated] This field is deprecated. |
| }, |
| "name": "A 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. |
| "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. |
| # Uses default project network if unspecified. |
| "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. |
| "pscData": { # All data that is specifically relevant to only network endpoint groups of # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. |
| # type PRIVATE_SERVICE_CONNECT. |
| "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP |
| # address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in |
| # L7 PSC-XLB. |
| "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on |
| # the PSC Producer side; should only be used for the |
| # PRIVATE_SERVICE_CONNECT NEG type |
| "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group |
| # Consumer. |
| "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. |
| }, |
| "pscTargetService": "A String", # The target service url used to set up private service connection to |
| # a Google API or a PSC Producer Service Attachment. |
| # An example value is: asia-northeast3-cloudkms.googleapis.com. |
| # |
| # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the network endpoint group is located. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. # Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set. |
| # |
| # Note: The target backend service must be in the same project and located in |
| # the same region as the Serverless NEG. |
| "platform": "A String", # The platform of the backend target(s) of this NEG. |
| # The only supported value is |
| # API Gateway: apigateway.googleapis.com. |
| "resource": "A String", # The user-defined name of the workload/instance. This value must be |
| # provided explicitly or in the urlMask. The resource |
| # identified by this value is platform-specific and is as follows: |
| # |
| # |
| # |
| # 1. API Gateway: The gateway ID |
| # 2. App Engine: The service name |
| # 3. Cloud Functions: The function name |
| # 4. Cloud Run: The service name |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse platform-specific fields from a request URL. URL mask |
| # allows for routing to multiple resources on the same serverless platform |
| # without having to create multiple Network Endpoint Groups and backend |
| # resources. The fields parsed by this template are platform-specific and |
| # are as follows: |
| # |
| # |
| # |
| # 1. API Gateway: The gateway ID |
| # 2. App Engine: The service and version |
| # 3. Cloud Functions: The function name |
| # 4. Cloud Run: The service and tag |
| "version": "A String", # The optional resource version. The version identified by this value is |
| # platform-specific and is follows: |
| # |
| # |
| # |
| # 1. API Gateway: Unused |
| # 2. App Engine: The service version |
| # 3. Cloud Functions: Unused |
| # 4. Cloud Run: The service tag |
| }, |
| "size": 42, # [Output only] Number of network endpoints in the network endpoint group. |
| "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG |
| # belong. |
| "type": "A String", # Specify the type of this network endpoint group. OnlyLOAD_BALANCING is valid for now. |
| "zone": "A String", # [Output Only] The URL of thezone |
| # where the network endpoint group is located. |
| }, |
| ], |
| "warning": { # [Output Only] An informational warning that replaces the list of network |
| # endpoint groups when the list is empty. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| # Engine returns NO_RESULTS_ON_PAGE if there |
| # are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being |
| # returned. For example, for warnings where there are no results in a list |
| # request for a particular zone, this key might be scope and |
| # the key value might be the zone name. Other examples might be a key |
| # indicating a deprecated resource and a suggested replacement, or a |
| # warning about invalid network settings (for example, if an instance |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }, |
| }, |
| "kind": "compute#networkEndpointGroupAggregatedList", # [Output Only] The resource type, which is alwayscompute#networkEndpointGroupAggregatedList for aggregated |
| # lists of network endpoint groups. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| # the query parameter pageToken in the next list request. |
| # Subsequent list requests will have their own nextPageToken to |
| # continue paging through the results. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "unreachables": [ # [Output Only] Unreachable resources. |
| "A String", |
| ], |
| "warning": { # [Output Only] Informational warning message. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| # Engine returns NO_RESULTS_ON_PAGE if there |
| # are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being |
| # returned. For example, for warnings where there are no results in a list |
| # request for a particular zone, this key might be scope and |
| # the key value might be the zone name. Other examples might be a key |
| # indicating a deprecated resource and a suggested replacement, or a |
| # warning about invalid network settings (for example, if an instance |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="aggregatedList_next">aggregatedList_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Attach a list of network endpoints to the specified network endpoint group. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| zone: string, The name of the zone where |
| the network endpoint group is located. It should comply with RFC1035. (required) |
| networkEndpointGroup: string, The name of the network endpoint group where you are attaching network |
| endpoints to. It should comply with RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "networkEndpoints": [ # The list of network endpoints to be attached. |
| { # The network endpoint. |
| "annotations": { # Optional metadata defined as annotations on the network endpoint. |
| "a_key": "A String", |
| }, |
| "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. |
| # |
| # Optional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type. |
| "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be |
| # specified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT. |
| "instance": "A String", # The name or a URL of VM instance of this network endpoint. |
| # Optional, the field presence depends on the network endpoint type. The |
| # field is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT. |
| # |
| # The instance must be in the same zone of network endpoint group (for zonal |
| # NEGs) or in the zone within the region of the NEG (for regional NEGs). |
| # If the ipAddress is specified, it must belongs to the VM |
| # instance. |
| # |
| # The name must be 1-63 characters long, and comply withRFC1035 |
| # or be a valid URL pointing to an existing instance. |
| "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a |
| # VM in Compute Engine (either the primary IP or as part of an aliased IP |
| # range). If the IP address is not specified, then the primary IP address for |
| # the VM instance in the network that the network endpoint group belongs to |
| # will be used. |
| # |
| # This field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP |
| # address of the attached VM instance that matches the subnetwork of the NEG. |
| # The primary internal IP address from any NIC of a multi-NIC VM instance can |
| # be added to a NEG as long as it matches the NEG subnetwork. |
| "ipv6Address": "A String", # Optional IPv6 address of network endpoint. |
| "port": 42, # Optional port number of network endpoint. If not specified, the |
| # defaultPort for the network endpoint group will be used. |
| # |
| # This field can not be set for network endpoints of typeGCE_VM_IP. |
| }, |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error |
| # status code that was returned. For example, a `404` means the |
| # resource was not found. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. |
| # There is no requirement that this be linear or support any granularity of |
| # operations. This should not be used to guess when the operation will be |
| # complete. This number should monotonically increase as the operation |
| # progresses. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| # Engine returns NO_RESULTS_ON_PAGE if there |
| # are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being |
| # returned. For example, for warnings where there are no results in a list |
| # request for a particular zone, this key might be scope and |
| # the key value might be the zone name. Other examples might be a key |
| # indicating a deprecated resource and a suggested replacement, or a |
| # warning about invalid network settings (for example, if an instance |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(project, zone, networkEndpointGroup, requestId=None, x__xgafv=None)</code> |
| <pre>Deletes the specified network endpoint group. The network endpoints in the |
| NEG and the VM instances they belong to are not terminated when the NEG is |
| deleted. Note that the NEG cannot be deleted if there are backend services |
| referencing it. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| zone: string, The name of the zone where |
| the network endpoint group is located. It should comply with RFC1035. (required) |
| networkEndpointGroup: string, The name of the network endpoint group to delete. It should comply with |
| RFC1035. (required) |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error |
| # status code that was returned. For example, a `404` means the |
| # resource was not found. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. |
| # There is no requirement that this be linear or support any granularity of |
| # operations. This should not be used to guess when the operation will be |
| # complete. This number should monotonically increase as the operation |
| # progresses. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| # Engine returns NO_RESULTS_ON_PAGE if there |
| # are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being |
| # returned. For example, for warnings where there are no results in a list |
| # request for a particular zone, this key might be scope and |
| # the key value might be the zone name. Other examples might be a key |
| # indicating a deprecated resource and a suggested replacement, or a |
| # warning about invalid network settings (for example, if an instance |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Detach a list of network endpoints from the specified network endpoint |
| group. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| zone: string, The name of the zone where |
| the network endpoint group is located. It should comply with RFC1035. (required) |
| networkEndpointGroup: string, The name of the network endpoint group where you are removing network |
| endpoints. It should comply with RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "networkEndpoints": [ # The list of network endpoints to be detached. |
| { # The network endpoint. |
| "annotations": { # Optional metadata defined as annotations on the network endpoint. |
| "a_key": "A String", |
| }, |
| "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. |
| # |
| # Optional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type. |
| "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be |
| # specified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT. |
| "instance": "A String", # The name or a URL of VM instance of this network endpoint. |
| # Optional, the field presence depends on the network endpoint type. The |
| # field is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT. |
| # |
| # The instance must be in the same zone of network endpoint group (for zonal |
| # NEGs) or in the zone within the region of the NEG (for regional NEGs). |
| # If the ipAddress is specified, it must belongs to the VM |
| # instance. |
| # |
| # The name must be 1-63 characters long, and comply withRFC1035 |
| # or be a valid URL pointing to an existing instance. |
| "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a |
| # VM in Compute Engine (either the primary IP or as part of an aliased IP |
| # range). If the IP address is not specified, then the primary IP address for |
| # the VM instance in the network that the network endpoint group belongs to |
| # will be used. |
| # |
| # This field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP |
| # address of the attached VM instance that matches the subnetwork of the NEG. |
| # The primary internal IP address from any NIC of a multi-NIC VM instance can |
| # be added to a NEG as long as it matches the NEG subnetwork. |
| "ipv6Address": "A String", # Optional IPv6 address of network endpoint. |
| "port": 42, # Optional port number of network endpoint. If not specified, the |
| # defaultPort for the network endpoint group will be used. |
| # |
| # This field can not be set for network endpoints of typeGCE_VM_IP. |
| }, |
| ], |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error |
| # status code that was returned. For example, a `404` means the |
| # resource was not found. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. |
| # There is no requirement that this be linear or support any granularity of |
| # operations. This should not be used to guess when the operation will be |
| # complete. This number should monotonically increase as the operation |
| # progresses. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| # Engine returns NO_RESULTS_ON_PAGE if there |
| # are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being |
| # returned. For example, for warnings where there are no results in a list |
| # request for a particular zone, this key might be scope and |
| # the key value might be the zone name. Other examples might be a key |
| # indicating a deprecated resource and a suggested replacement, or a |
| # warning about invalid network settings (for example, if an instance |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, zone, networkEndpointGroup, x__xgafv=None)</code> |
| <pre>Returns the specified network endpoint group. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| zone: string, The name of the zone where |
| the network endpoint group is located. It should comply with RFC1035. (required) |
| networkEndpointGroup: string, The name of the network endpoint group. It should comply with RFC1035. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a collection of network endpoints. |
| # |
| # A network endpoint group (NEG) defines how a set of endpoints should be |
| # reached, whether they are reachable, and where they are located. |
| # For more information about using NEGs for different use cases, seeNetwork endpoint groups overview. |
| "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. |
| "a_key": "A String", |
| }, |
| "appEngine": { # Configuration for an App Engine network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The service is optional, may be provided explicitly or in the |
| # URL mask. The version is optional and can only be provided |
| # explicitly or in the URL mask when service is present. |
| # |
| # Note: App Engine service must be in the same project and located in the |
| # same region as the Serverless NEG. |
| "service": "A String", # Optional serving service. |
| # |
| # The service name is case-sensitive and must be 1-63 |
| # characters long. |
| # |
| # Example value: default, my-service. |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse service and version fields |
| # from a request URL. URL mask allows for routing to multiple App Engine |
| # services without having to create multiple Network Endpoint Groups and |
| # backend services. |
| # |
| # For example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same |
| # Serverless NEG with URL mask<service>-dot-appname.appspot.com/<version>. |
| # The URL mask will parse them to { service = "foo1", version = "v1" |
| # } and { service = "foo1", version = "v2" } |
| # respectively. |
| "version": "A String", # Optional serving version. |
| # |
| # The version name is case-sensitive and must be 1-100 |
| # characters long. |
| # |
| # Example value: v1, v2. |
| }, |
| "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The function must be provided explicitly or in the URL mask. |
| # |
| # Note: Cloud Function must be in the same project and located in the same |
| # region as the Serverless NEG. |
| "function": "A String", # A user-defined name of the Cloud Function. |
| # |
| # The function name is case-sensitive and must be 1-63 |
| # characters long. |
| # |
| # Example value: func1. |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse function field from a request URL. URL |
| # mask allows for routing to multiple Cloud Functions without having to |
| # create multiple Network Endpoint Groups and backend services. |
| # |
| # For example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same |
| # Serverless NEG with URL mask /<function>. The URL |
| # mask will parse them to { function = "function1" } and{ function = "function2" } respectively. |
| }, |
| "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The service must be provided explicitly or in the URL mask. |
| # The tag is optional, may be provided explicitly or in the URL |
| # mask. |
| # |
| # Note: Cloud Run service must be in the same project and located in the same |
| # region as the Serverless NEG. |
| "service": "A String", # Cloud Run service is the main resource of Cloud Run. |
| # |
| # The service must be 1-63 characters long, and comply withRFC1035. |
| # |
| # Example value: "run-service". |
| "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional |
| # fine-grained traffic routing information. |
| # |
| # The tag must be 1-63 characters long, and comply withRFC1035. |
| # |
| # Example value: "revision-0010". |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse <service> and<tag> fields from a request URL. URL mask allows for |
| # routing to multiple Run services without having to create multiple |
| # network endpoint groups and backend services. |
| # |
| # For example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless |
| # Network Endpoint Group (NEG) with URL mask<tag>.domain.com/<service>. The URL mask will |
| # parse them to { service="bar1", tag="foo1" } and { |
| # service="bar2", tag="foo2" } respectively. |
| }, |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "defaultPort": 42, # The default port used if the port number is not specified in the network |
| # endpoint. |
| # |
| # Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this |
| # field must not be specified. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group. |
| "loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load |
| # balancing. |
| # [Deprecated] This field is deprecated. |
| "defaultPort": 42, # The default port used if the port number is not specified in the network |
| # endpoint. |
| # |
| # If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this |
| # field must not be specified. |
| # [Deprecated] This field is deprecated. |
| "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. |
| # Uses default project network if unspecified. |
| # [Deprecated] This field is deprecated. |
| "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG |
| # belong. |
| # [Deprecated] This field is deprecated. |
| "zone": "A String", # [Output Only] The URL of thezone |
| # where the network endpoint group is located. |
| # [Deprecated] This field is deprecated. |
| }, |
| "name": "A 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. |
| "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. |
| # Uses default project network if unspecified. |
| "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. |
| "pscData": { # All data that is specifically relevant to only network endpoint groups of # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. |
| # type PRIVATE_SERVICE_CONNECT. |
| "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP |
| # address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in |
| # L7 PSC-XLB. |
| "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on |
| # the PSC Producer side; should only be used for the |
| # PRIVATE_SERVICE_CONNECT NEG type |
| "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group |
| # Consumer. |
| "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. |
| }, |
| "pscTargetService": "A String", # The target service url used to set up private service connection to |
| # a Google API or a PSC Producer Service Attachment. |
| # An example value is: asia-northeast3-cloudkms.googleapis.com. |
| # |
| # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the network endpoint group is located. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. # Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set. |
| # |
| # Note: The target backend service must be in the same project and located in |
| # the same region as the Serverless NEG. |
| "platform": "A String", # The platform of the backend target(s) of this NEG. |
| # The only supported value is |
| # API Gateway: apigateway.googleapis.com. |
| "resource": "A String", # The user-defined name of the workload/instance. This value must be |
| # provided explicitly or in the urlMask. The resource |
| # identified by this value is platform-specific and is as follows: |
| # |
| # |
| # |
| # 1. API Gateway: The gateway ID |
| # 2. App Engine: The service name |
| # 3. Cloud Functions: The function name |
| # 4. Cloud Run: The service name |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse platform-specific fields from a request URL. URL mask |
| # allows for routing to multiple resources on the same serverless platform |
| # without having to create multiple Network Endpoint Groups and backend |
| # resources. The fields parsed by this template are platform-specific and |
| # are as follows: |
| # |
| # |
| # |
| # 1. API Gateway: The gateway ID |
| # 2. App Engine: The service and version |
| # 3. Cloud Functions: The function name |
| # 4. Cloud Run: The service and tag |
| "version": "A String", # The optional resource version. The version identified by this value is |
| # platform-specific and is follows: |
| # |
| # |
| # |
| # 1. API Gateway: Unused |
| # 2. App Engine: The service version |
| # 3. Cloud Functions: Unused |
| # 4. Cloud Run: The service tag |
| }, |
| "size": 42, # [Output only] Number of network endpoints in the network endpoint group. |
| "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG |
| # belong. |
| "type": "A String", # Specify the type of this network endpoint group. OnlyLOAD_BALANCING is valid for now. |
| "zone": "A String", # [Output Only] The URL of thezone |
| # where the network endpoint group is located. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Creates a network endpoint group in the specified project using the |
| parameters that are included in the request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| zone: string, The name of the zone where |
| you want to create the network endpoint group. It should comply with |
| RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a collection of network endpoints. |
| # |
| # A network endpoint group (NEG) defines how a set of endpoints should be |
| # reached, whether they are reachable, and where they are located. |
| # For more information about using NEGs for different use cases, seeNetwork endpoint groups overview. |
| "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. |
| "a_key": "A String", |
| }, |
| "appEngine": { # Configuration for an App Engine network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The service is optional, may be provided explicitly or in the |
| # URL mask. The version is optional and can only be provided |
| # explicitly or in the URL mask when service is present. |
| # |
| # Note: App Engine service must be in the same project and located in the |
| # same region as the Serverless NEG. |
| "service": "A String", # Optional serving service. |
| # |
| # The service name is case-sensitive and must be 1-63 |
| # characters long. |
| # |
| # Example value: default, my-service. |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse service and version fields |
| # from a request URL. URL mask allows for routing to multiple App Engine |
| # services without having to create multiple Network Endpoint Groups and |
| # backend services. |
| # |
| # For example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same |
| # Serverless NEG with URL mask<service>-dot-appname.appspot.com/<version>. |
| # The URL mask will parse them to { service = "foo1", version = "v1" |
| # } and { service = "foo1", version = "v2" } |
| # respectively. |
| "version": "A String", # Optional serving version. |
| # |
| # The version name is case-sensitive and must be 1-100 |
| # characters long. |
| # |
| # Example value: v1, v2. |
| }, |
| "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The function must be provided explicitly or in the URL mask. |
| # |
| # Note: Cloud Function must be in the same project and located in the same |
| # region as the Serverless NEG. |
| "function": "A String", # A user-defined name of the Cloud Function. |
| # |
| # The function name is case-sensitive and must be 1-63 |
| # characters long. |
| # |
| # Example value: func1. |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse function field from a request URL. URL |
| # mask allows for routing to multiple Cloud Functions without having to |
| # create multiple Network Endpoint Groups and backend services. |
| # |
| # For example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same |
| # Serverless NEG with URL mask /<function>. The URL |
| # mask will parse them to { function = "function1" } and{ function = "function2" } respectively. |
| }, |
| "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The service must be provided explicitly or in the URL mask. |
| # The tag is optional, may be provided explicitly or in the URL |
| # mask. |
| # |
| # Note: Cloud Run service must be in the same project and located in the same |
| # region as the Serverless NEG. |
| "service": "A String", # Cloud Run service is the main resource of Cloud Run. |
| # |
| # The service must be 1-63 characters long, and comply withRFC1035. |
| # |
| # Example value: "run-service". |
| "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional |
| # fine-grained traffic routing information. |
| # |
| # The tag must be 1-63 characters long, and comply withRFC1035. |
| # |
| # Example value: "revision-0010". |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse <service> and<tag> fields from a request URL. URL mask allows for |
| # routing to multiple Run services without having to create multiple |
| # network endpoint groups and backend services. |
| # |
| # For example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless |
| # Network Endpoint Group (NEG) with URL mask<tag>.domain.com/<service>. The URL mask will |
| # parse them to { service="bar1", tag="foo1" } and { |
| # service="bar2", tag="foo2" } respectively. |
| }, |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "defaultPort": 42, # The default port used if the port number is not specified in the network |
| # endpoint. |
| # |
| # Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this |
| # field must not be specified. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group. |
| "loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load |
| # balancing. |
| # [Deprecated] This field is deprecated. |
| "defaultPort": 42, # The default port used if the port number is not specified in the network |
| # endpoint. |
| # |
| # If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this |
| # field must not be specified. |
| # [Deprecated] This field is deprecated. |
| "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. |
| # Uses default project network if unspecified. |
| # [Deprecated] This field is deprecated. |
| "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG |
| # belong. |
| # [Deprecated] This field is deprecated. |
| "zone": "A String", # [Output Only] The URL of thezone |
| # where the network endpoint group is located. |
| # [Deprecated] This field is deprecated. |
| }, |
| "name": "A 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. |
| "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. |
| # Uses default project network if unspecified. |
| "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. |
| "pscData": { # All data that is specifically relevant to only network endpoint groups of # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. |
| # type PRIVATE_SERVICE_CONNECT. |
| "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP |
| # address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in |
| # L7 PSC-XLB. |
| "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on |
| # the PSC Producer side; should only be used for the |
| # PRIVATE_SERVICE_CONNECT NEG type |
| "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group |
| # Consumer. |
| "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. |
| }, |
| "pscTargetService": "A String", # The target service url used to set up private service connection to |
| # a Google API or a PSC Producer Service Attachment. |
| # An example value is: asia-northeast3-cloudkms.googleapis.com. |
| # |
| # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the network endpoint group is located. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. # Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set. |
| # |
| # Note: The target backend service must be in the same project and located in |
| # the same region as the Serverless NEG. |
| "platform": "A String", # The platform of the backend target(s) of this NEG. |
| # The only supported value is |
| # API Gateway: apigateway.googleapis.com. |
| "resource": "A String", # The user-defined name of the workload/instance. This value must be |
| # provided explicitly or in the urlMask. The resource |
| # identified by this value is platform-specific and is as follows: |
| # |
| # |
| # |
| # 1. API Gateway: The gateway ID |
| # 2. App Engine: The service name |
| # 3. Cloud Functions: The function name |
| # 4. Cloud Run: The service name |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse platform-specific fields from a request URL. URL mask |
| # allows for routing to multiple resources on the same serverless platform |
| # without having to create multiple Network Endpoint Groups and backend |
| # resources. The fields parsed by this template are platform-specific and |
| # are as follows: |
| # |
| # |
| # |
| # 1. API Gateway: The gateway ID |
| # 2. App Engine: The service and version |
| # 3. Cloud Functions: The function name |
| # 4. Cloud Run: The service and tag |
| "version": "A String", # The optional resource version. The version identified by this value is |
| # platform-specific and is follows: |
| # |
| # |
| # |
| # 1. API Gateway: Unused |
| # 2. App Engine: The service version |
| # 3. Cloud Functions: Unused |
| # 4. Cloud Run: The service tag |
| }, |
| "size": 42, # [Output only] Number of network endpoints in the network endpoint group. |
| "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG |
| # belong. |
| "type": "A String", # Specify the type of this network endpoint group. OnlyLOAD_BALANCING is valid for now. |
| "zone": "A String", # [Output Only] The URL of thezone |
| # where the network endpoint group is located. |
| } |
| |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| that if you must retry your request, the server will know to ignore the |
| request if it has already been completed. |
| |
| For example, consider a situation where you make an initial request and |
| the request times out. If you make the request again with the same |
| request ID, the server can check if original operation with the same |
| request ID was received, and if so, will ignore the second request. This |
| prevents clients from accidentally creating duplicate commitments. |
| |
| The request ID must be |
| a valid UUID with the exception that zero UUID is not supported |
| (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # |
| # - For global operations, use the `globalOperations` |
| # resource. |
| # - For regional operations, use the |
| # `regionOperations` resource. |
| # - For zonal operations, use |
| # the `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| # Not present otherwise. |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| "description": "A String", # [Output Only] A textual description of the operation, which is |
| # set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| # text format. |
| "error": { # [Output Only] If errors are generated during processing of the operation, |
| # this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this |
| # operation. |
| { |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| # This property is optional. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| # message that was returned, such as `NOT FOUND`. |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error |
| # status code that was returned. For example, a `404` means the |
| # resource was not found. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| # defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. |
| # This value is inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| # `update`, or `delete`, and so on. |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. |
| # There is no requirement that this be linear or support any granularity of |
| # operations. This should not be used to guess when the operation will be |
| # complete. This number should monotonically increase as the operation |
| # progresses. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| # applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the |
| # following: |
| # `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| # operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| # of the target resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| # operations related to creating a snapshot, this points to the disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `[email protected]` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the |
| # operation, this field will be populated. |
| { |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| # Engine returns NO_RESULTS_ON_PAGE if there |
| # are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being |
| # returned. For example, for warnings where there are no results in a list |
| # request for a particular zone, this key might be scope and |
| # the key value might be the zone name. Other examples might be a key |
| # indicating a deprecated resource and a suggested replacement, or a |
| # warning about invalid network settings (for example, if an instance |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| # applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| <pre>Retrieves the list of network endpoint groups that are located in the |
| specified project and zone. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| zone: string, The name of thezone |
| where the network endpoint group is located. It should comply with RFC1035. (required) |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource labels. |
| |
| To filter on multiple expressions, provide each separate expression within |
| parentheses. For example: |
| ``` |
| (scheduling.automaticRestart = true) |
| (cpuPlatform = "Intel Skylake") |
| ``` |
| By default, each expression is an `AND` expression. However, you |
| can include `AND` and `OR` expressions explicitly. |
| For example: |
| ``` |
| (cpuPlatform = "Intel Skylake") OR |
| (cpuPlatform = "Intel Broadwell") AND |
| (scheduling.automaticRestart = true) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| maxResults: integer, The maximum number of results per page that should be returned. |
| If the number of available results is larger than `maxResults`, |
| Compute Engine returns a `nextPageToken` that can be used to get |
| the next page of results in subsequent list requests. Acceptable values are |
| `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results |
| are returned in alphanumerical order based on the resource name. |
| |
| You can also sort results in descending order based on the creation |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts |
| results based on the `creationTimestamp` field in |
| reverse chronological order (newest result first). Use this to sort |
| resources like operations so that the newest operation is returned first. |
| |
| Currently, only sorting by `name` or |
| `creationTimestamp desc` is supported. |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the |
| `nextPageToken` returned by a previous list request to get |
| the next page of results. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": [ # A list of NetworkEndpointGroup resources. |
| { # Represents a collection of network endpoints. |
| # |
| # A network endpoint group (NEG) defines how a set of endpoints should be |
| # reached, whether they are reachable, and where they are located. |
| # For more information about using NEGs for different use cases, seeNetwork endpoint groups overview. |
| "annotations": { # Optional. Metadata defined as annotations on the network endpoint group. |
| "a_key": "A String", |
| }, |
| "appEngine": { # Configuration for an App Engine network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The service is optional, may be provided explicitly or in the |
| # URL mask. The version is optional and can only be provided |
| # explicitly or in the URL mask when service is present. |
| # |
| # Note: App Engine service must be in the same project and located in the |
| # same region as the Serverless NEG. |
| "service": "A String", # Optional serving service. |
| # |
| # The service name is case-sensitive and must be 1-63 |
| # characters long. |
| # |
| # Example value: default, my-service. |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse service and version fields |
| # from a request URL. URL mask allows for routing to multiple App Engine |
| # services without having to create multiple Network Endpoint Groups and |
| # backend services. |
| # |
| # For example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same |
| # Serverless NEG with URL mask<service>-dot-appname.appspot.com/<version>. |
| # The URL mask will parse them to { service = "foo1", version = "v1" |
| # } and { service = "foo1", version = "v2" } |
| # respectively. |
| "version": "A String", # Optional serving version. |
| # |
| # The version name is case-sensitive and must be 1-100 |
| # characters long. |
| # |
| # Example value: v1, v2. |
| }, |
| "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The function must be provided explicitly or in the URL mask. |
| # |
| # Note: Cloud Function must be in the same project and located in the same |
| # region as the Serverless NEG. |
| "function": "A String", # A user-defined name of the Cloud Function. |
| # |
| # The function name is case-sensitive and must be 1-63 |
| # characters long. |
| # |
| # Example value: func1. |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse function field from a request URL. URL |
| # mask allows for routing to multiple Cloud Functions without having to |
| # create multiple Network Endpoint Groups and backend services. |
| # |
| # For example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same |
| # Serverless NEG with URL mask /<function>. The URL |
| # mask will parse them to { function = "function1" } and{ function = "function2" } respectively. |
| }, |
| "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). # Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set. |
| # The service must be provided explicitly or in the URL mask. |
| # The tag is optional, may be provided explicitly or in the URL |
| # mask. |
| # |
| # Note: Cloud Run service must be in the same project and located in the same |
| # region as the Serverless NEG. |
| "service": "A String", # Cloud Run service is the main resource of Cloud Run. |
| # |
| # The service must be 1-63 characters long, and comply withRFC1035. |
| # |
| # Example value: "run-service". |
| "tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional |
| # fine-grained traffic routing information. |
| # |
| # The tag must be 1-63 characters long, and comply withRFC1035. |
| # |
| # Example value: "revision-0010". |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse <service> and<tag> fields from a request URL. URL mask allows for |
| # routing to multiple Run services without having to create multiple |
| # network endpoint groups and backend services. |
| # |
| # For example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless |
| # Network Endpoint Group (NEG) with URL mask<tag>.domain.com/<service>. The URL mask will |
| # parse them to { service="bar1", tag="foo1" } and { |
| # service="bar2", tag="foo2" } respectively. |
| }, |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "defaultPort": 42, # The default port used if the port number is not specified in the network |
| # endpoint. |
| # |
| # Optional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this |
| # field must not be specified. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group. |
| "loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load |
| # balancing. |
| # [Deprecated] This field is deprecated. |
| "defaultPort": 42, # The default port used if the port number is not specified in the network |
| # endpoint. |
| # |
| # If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this |
| # field must not be specified. |
| # [Deprecated] This field is deprecated. |
| "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. |
| # Uses default project network if unspecified. |
| # [Deprecated] This field is deprecated. |
| "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG |
| # belong. |
| # [Deprecated] This field is deprecated. |
| "zone": "A String", # [Output Only] The URL of thezone |
| # where the network endpoint group is located. |
| # [Deprecated] This field is deprecated. |
| }, |
| "name": "A 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. |
| "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. |
| # Uses default project network if unspecified. |
| "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP. |
| "pscData": { # All data that is specifically relevant to only network endpoint groups of # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. |
| # type PRIVATE_SERVICE_CONNECT. |
| "consumerPscAddress": "A String", # [Output Only] Address allocated from given subnetwork for PSC. This IP |
| # address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in |
| # L7 PSC-XLB. |
| "producerPort": 42, # The psc producer port is used to connect PSC NEG with specific port on |
| # the PSC Producer side; should only be used for the |
| # PRIVATE_SERVICE_CONNECT NEG type |
| "pscConnectionId": "A String", # [Output Only] The PSC connection id of the PSC Network Endpoint Group |
| # Consumer. |
| "pscConnectionStatus": "A String", # [Output Only] The connection status of the PSC Forwarding Rule. |
| }, |
| "pscTargetService": "A String", # The target service url used to set up private service connection to |
| # a Google API or a PSC Producer Service Attachment. |
| # An example value is: asia-northeast3-cloudkms.googleapis.com. |
| # |
| # Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT. |
| "region": "A String", # [Output Only] The URL of theregion |
| # where the network endpoint group is located. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| "serverlessDeployment": { # Configuration for a serverless network endpoint group (NEG). Theplatform must be provided. # Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine, cloudFunction orserverlessDeployment may be set. |
| # |
| # Note: The target backend service must be in the same project and located in |
| # the same region as the Serverless NEG. |
| "platform": "A String", # The platform of the backend target(s) of this NEG. |
| # The only supported value is |
| # API Gateway: apigateway.googleapis.com. |
| "resource": "A String", # The user-defined name of the workload/instance. This value must be |
| # provided explicitly or in the urlMask. The resource |
| # identified by this value is platform-specific and is as follows: |
| # |
| # |
| # |
| # 1. API Gateway: The gateway ID |
| # 2. App Engine: The service name |
| # 3. Cloud Functions: The function name |
| # 4. Cloud Run: The service name |
| "urlMask": "A String", # An URL |
| # mask is one of the main components of the Cloud Function. |
| # |
| # A template to parse platform-specific fields from a request URL. URL mask |
| # allows for routing to multiple resources on the same serverless platform |
| # without having to create multiple Network Endpoint Groups and backend |
| # resources. The fields parsed by this template are platform-specific and |
| # are as follows: |
| # |
| # |
| # |
| # 1. API Gateway: The gateway ID |
| # 2. App Engine: The service and version |
| # 3. Cloud Functions: The function name |
| # 4. Cloud Run: The service and tag |
| "version": "A String", # The optional resource version. The version identified by this value is |
| # platform-specific and is follows: |
| # |
| # |
| # |
| # 1. API Gateway: Unused |
| # 2. App Engine: The service version |
| # 3. Cloud Functions: Unused |
| # 4. Cloud Run: The service tag |
| }, |
| "size": 42, # [Output only] Number of network endpoints in the network endpoint group. |
| "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG |
| # belong. |
| "type": "A String", # Specify the type of this network endpoint group. OnlyLOAD_BALANCING is valid for now. |
| "zone": "A String", # [Output Only] The URL of thezone |
| # where the network endpoint group is located. |
| }, |
| ], |
| "kind": "compute#networkEndpointGroupList", # [Output Only] The resource type, which is alwayscompute#networkEndpointGroupList for network endpoint group |
| # lists. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| # the query parameter pageToken in the next list request. |
| # Subsequent list requests will have their own nextPageToken to |
| # continue paging through the results. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "warning": { # [Output Only] Informational warning message. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| # Engine returns NO_RESULTS_ON_PAGE if there |
| # are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being |
| # returned. For example, for warnings where there are no results in a list |
| # request for a particular zone, this key might be scope and |
| # the key value might be the zone name. Other examples might be a key |
| # indicating a deprecated resource and a suggested replacement, or a |
| # warning about invalid network settings (for example, if an instance |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| <pre>Lists the network endpoints in the specified network endpoint group. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| zone: string, The name of the zone where |
| the network endpoint group is located. It should comply with RFC1035. (required) |
| networkEndpointGroup: string, The name of the network endpoint group from which you want to generate a |
| list of included network endpoints. It should comply with RFC1035. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "endpointFilters": [ # Optional list of endpoints to query. |
| # This is a more efficient but also limited version of filter parameter. |
| # Endpoints in the filter must have ip_address and port fields populated, |
| # other fields are not supported. |
| { |
| "networkEndpoint": { # The network endpoint. |
| "annotations": { # Optional metadata defined as annotations on the network endpoint. |
| "a_key": "A String", |
| }, |
| "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. |
| # |
| # Optional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type. |
| "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be |
| # specified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT. |
| "instance": "A String", # The name or a URL of VM instance of this network endpoint. |
| # Optional, the field presence depends on the network endpoint type. The |
| # field is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT. |
| # |
| # The instance must be in the same zone of network endpoint group (for zonal |
| # NEGs) or in the zone within the region of the NEG (for regional NEGs). |
| # If the ipAddress is specified, it must belongs to the VM |
| # instance. |
| # |
| # The name must be 1-63 characters long, and comply withRFC1035 |
| # or be a valid URL pointing to an existing instance. |
| "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a |
| # VM in Compute Engine (either the primary IP or as part of an aliased IP |
| # range). If the IP address is not specified, then the primary IP address for |
| # the VM instance in the network that the network endpoint group belongs to |
| # will be used. |
| # |
| # This field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP |
| # address of the attached VM instance that matches the subnetwork of the NEG. |
| # The primary internal IP address from any NIC of a multi-NIC VM instance can |
| # be added to a NEG as long as it matches the NEG subnetwork. |
| "ipv6Address": "A String", # Optional IPv6 address of network endpoint. |
| "port": 42, # Optional port number of network endpoint. If not specified, the |
| # defaultPort for the network endpoint group will be used. |
| # |
| # This field can not be set for network endpoints of typeGCE_VM_IP. |
| }, |
| }, |
| ], |
| "healthStatus": "A String", # Optional query parameter for showing the health status of each network |
| # endpoint. Valid options are SKIP or SHOW. If you |
| # don't specify this parameter, the health status of network endpoints will |
| # not be provided. |
| } |
| |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource labels. |
| |
| To filter on multiple expressions, provide each separate expression within |
| parentheses. For example: |
| ``` |
| (scheduling.automaticRestart = true) |
| (cpuPlatform = "Intel Skylake") |
| ``` |
| By default, each expression is an `AND` expression. However, you |
| can include `AND` and `OR` expressions explicitly. |
| For example: |
| ``` |
| (cpuPlatform = "Intel Skylake") OR |
| (cpuPlatform = "Intel Broadwell") AND |
| (scheduling.automaticRestart = true) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| maxResults: integer, The maximum number of results per page that should be returned. |
| If the number of available results is larger than `maxResults`, |
| Compute Engine returns a `nextPageToken` that can be used to get |
| the next page of results in subsequent list requests. Acceptable values are |
| `0` to `500`, inclusive. (Default: `500`) |
| orderBy: string, Sorts list results by a certain order. By default, results |
| are returned in alphanumerical order based on the resource name. |
| |
| You can also sort results in descending order based on the creation |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts |
| results based on the `creationTimestamp` field in |
| reverse chronological order (newest result first). Use this to sort |
| resources like operations so that the newest operation is returned first. |
| |
| Currently, only sorting by `name` or |
| `creationTimestamp desc` is supported. |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the |
| `nextPageToken` returned by a previous list request to get |
| the next page of results. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": [ # A list of NetworkEndpointWithHealthStatus resources. |
| { |
| "healths": [ # [Output only] The health status of network endpoint. |
| # |
| # Optional. Displayed only if the network endpoint has centralized health |
| # checking configured. |
| { |
| "backendService": { # URL of the backend service associated with the health state of the network |
| # endpoint. |
| "backendService": "A String", |
| }, |
| "forwardingRule": { # URL of the forwarding rule associated with the health state of the network |
| # endpoint. |
| "forwardingRule": "A String", |
| }, |
| "healthCheck": { # A full or valid partial URL to a health check. For example, the following are # URL of the health check associated with the health state of the network |
| # endpoint. |
| # valid URLs: |
| # |
| # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check |
| # - projects/project-id/global/httpHealthChecks/health-check |
| # - global/httpHealthChecks/health-check |
| "healthCheck": "A String", |
| }, |
| "healthCheckService": { # A full or valid partial URL to a health check service. For example, the # URL of the health check service associated with the health state of the |
| # network endpoint. |
| # following are valid URLs: |
| # |
| # - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service |
| # - projects/project-id/regions/us-west1/healthCheckServices/health-check-service |
| # - regions/us-west1/healthCheckServices/health-check-service |
| "healthCheckService": "A String", |
| }, |
| "healthState": "A String", # Health state of the network endpoint determined based on the health checks |
| # configured. |
| "ipv6HealthState": "A String", # Health state of the ipv6 network endpoint determined based on the health |
| # checks configured. |
| }, |
| ], |
| "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint. |
| "annotations": { # Optional metadata defined as annotations on the network endpoint. |
| "a_key": "A String", |
| }, |
| "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. |
| # |
| # Optional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type. |
| "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be |
| # specified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT. |
| "instance": "A String", # The name or a URL of VM instance of this network endpoint. |
| # Optional, the field presence depends on the network endpoint type. The |
| # field is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT. |
| # |
| # The instance must be in the same zone of network endpoint group (for zonal |
| # NEGs) or in the zone within the region of the NEG (for regional NEGs). |
| # If the ipAddress is specified, it must belongs to the VM |
| # instance. |
| # |
| # The name must be 1-63 characters long, and comply withRFC1035 |
| # or be a valid URL pointing to an existing instance. |
| "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a |
| # VM in Compute Engine (either the primary IP or as part of an aliased IP |
| # range). If the IP address is not specified, then the primary IP address for |
| # the VM instance in the network that the network endpoint group belongs to |
| # will be used. |
| # |
| # This field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP |
| # address of the attached VM instance that matches the subnetwork of the NEG. |
| # The primary internal IP address from any NIC of a multi-NIC VM instance can |
| # be added to a NEG as long as it matches the NEG subnetwork. |
| "ipv6Address": "A String", # Optional IPv6 address of network endpoint. |
| "port": 42, # Optional port number of network endpoint. If not specified, the |
| # defaultPort for the network endpoint group will be used. |
| # |
| # This field can not be set for network endpoints of typeGCE_VM_IP. |
| }, |
| }, |
| ], |
| "kind": "compute#networkEndpointGroupsListNetworkEndpoints", # [Output Only] The resource type, which is alwayscompute#networkEndpointGroupsListNetworkEndpoints for the list |
| # of network endpoints in the specified network endpoint group. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| # the query parameter pageToken in the next list request. |
| # Subsequent list requests will have their own nextPageToken to |
| # continue paging through the results. |
| "warning": { # [Output Only] Informational warning message. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| # Engine returns NO_RESULTS_ON_PAGE if there |
| # are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: |
| # value format. For example: |
| # |
| # "data": [ |
| # { |
| # "key": "scope", |
| # "value": "zones/us-east1-d" |
| # } |
| { |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being |
| # returned. For example, for warnings where there are no results in a list |
| # request for a particular zone, this key might be scope and |
| # the key value might be the zone name. Other examples might be a key |
| # indicating a deprecated resource and a suggested replacement, or a |
| # warning about invalid network settings (for example, if an instance |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listNetworkEndpoints_next">listNetworkEndpoints_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified resource. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| zone: string, The name of the zone for this request. (required) |
| resource: string, Name or id of the resource for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "permissions": [ # The set of permissions to check for the 'resource'. Permissions with |
| # wildcards (such as '*' or 'storage.*') are not allowed. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
