docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/compute_v1.networkEndpointGroups.html b/docs/dyn/compute_v1.networkEndpointGroups.html
index 63cb4dd..ec237eb 100644
--- a/docs/dyn/compute_v1.networkEndpointGroups.html
+++ b/docs/dyn/compute_v1.networkEndpointGroups.html
@@ -75,7 +75,7 @@
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.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)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=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(previous_request, previous_response)</a></code></p>
@@ -84,6 +84,9 @@
<code><a href="#attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=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)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
@@ -96,10 +99,10 @@
<code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p>
<p class="firstline">Creates a network endpoint group in the specified project using the parameters that are included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
+ <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
<p class="firstline">Retrieves the list of network endpoint groups that are located in the specified project and zone.</p>
<p class="toc_element">
- <code><a href="#listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
+ <code><a href="#listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=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(previous_request, previous_response)</a></code></p>
@@ -112,7 +115,7 @@
<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)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
<pre>Retrieves the list of network endpoint groups and sorts them by zone.
Args:
@@ -132,6 +135,7 @@
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 and the logic is the same as today.
Returns:
An object of the form:
@@ -143,10 +147,56 @@
"networkEndpointGroups": [ # [Output Only] The list of network 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, see Setting up internet NEGs or Setting up zonal NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==)
+ # 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, see Setting up internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)
"annotations": { # Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
+ "appEngine": { # Configuration for an App Engine network endpoint group (NEG). 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. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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 must be 1-63 characters long, and comply with RFC1035.
+ #
+ # Example value: "default", "my-service".
+ "urlMask": "A String", # 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 URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". 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 must be 1-63 characters long, and comply with RFC1035.
+ #
+ # Example value: "v1", "v2".
+ },
+ "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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", # 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" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively.
+ },
+ "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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 with RFC1035.
+ #
+ # 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 with RFC1035.
+ #
+ # Example value: "revision-0010".
+ "urlMask": "A String", # 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" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively.
+ },
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
@@ -154,7 +204,8 @@
"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
"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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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.
+ "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, or SERVERLESS.
+ "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"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.
@@ -177,6 +228,9 @@
"kind": "compute#networkEndpointGroupAggregatedList", # [Output Only] The resource type, which is always compute#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 than maxResults, 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:
@@ -302,6 +356,11 @@
</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)</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.
@@ -488,10 +547,56 @@
{ # 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, see Setting up internet NEGs or Setting up zonal NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==)
+ # 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, see Setting up internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)
"annotations": { # Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
+ "appEngine": { # Configuration for an App Engine network endpoint group (NEG). 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. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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 must be 1-63 characters long, and comply with RFC1035.
+ #
+ # Example value: "default", "my-service".
+ "urlMask": "A String", # 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 URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". 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 must be 1-63 characters long, and comply with RFC1035.
+ #
+ # Example value: "v1", "v2".
+ },
+ "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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", # 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" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively.
+ },
+ "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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 with RFC1035.
+ #
+ # 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 with RFC1035.
+ #
+ # Example value: "revision-0010".
+ "urlMask": "A String", # 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" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively.
+ },
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
@@ -499,7 +604,8 @@
"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
"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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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.
+ "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, or SERVERLESS.
+ "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"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.
@@ -519,10 +625,56 @@
{ # 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, see Setting up internet NEGs or Setting up zonal NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==)
+ # 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, see Setting up internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)
"annotations": { # Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
+ "appEngine": { # Configuration for an App Engine network endpoint group (NEG). 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. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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 must be 1-63 characters long, and comply with RFC1035.
+ #
+ # Example value: "default", "my-service".
+ "urlMask": "A String", # 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 URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". 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 must be 1-63 characters long, and comply with RFC1035.
+ #
+ # Example value: "v1", "v2".
+ },
+ "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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", # 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" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively.
+ },
+ "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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 with RFC1035.
+ #
+ # 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 with RFC1035.
+ #
+ # Example value: "revision-0010".
+ "urlMask": "A String", # 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" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively.
+ },
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
@@ -530,7 +682,8 @@
"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
"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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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.
+ "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, or SERVERLESS.
+ "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"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.
@@ -607,7 +760,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
+ <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
<pre>Retrieves the list of network endpoint groups that are located in the specified project and zone.
Args:
@@ -627,6 +780,7 @@
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 and the logic is the same as today.
Returns:
An object of the form:
@@ -636,10 +790,56 @@
"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, see Setting up internet NEGs or Setting up zonal NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==)
+ # 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, see Setting up internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)
"annotations": { # Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
+ "appEngine": { # Configuration for an App Engine network endpoint group (NEG). 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. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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 must be 1-63 characters long, and comply with RFC1035.
+ #
+ # Example value: "default", "my-service".
+ "urlMask": "A String", # 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 URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". 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 must be 1-63 characters long, and comply with RFC1035.
+ #
+ # Example value: "v1", "v2".
+ },
+ "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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", # 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" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively.
+ },
+ "cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.
+ #
+ # 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 with RFC1035.
+ #
+ # 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 with RFC1035.
+ #
+ # Example value: "revision-0010".
+ "urlMask": "A String", # 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" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively.
+ },
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
@@ -647,7 +847,8 @@
"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
"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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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.
+ "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, or SERVERLESS.
+ "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"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.
@@ -672,7 +873,7 @@
</div>
<div class="method">
- <code class="details" id="listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
+ <code class="details" id="listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
<pre>Lists the network endpoints in the specified network endpoint group.
Args:
@@ -700,6 +901,7 @@
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 and the logic is the same as today.
Returns:
An object of the form: