Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Creates a network endpoint group in the specified project using the parameters that are included in the request.

Retrieves the list of regional network endpoint groups available to the specified project in the given region.

Method Details

delete(project=*, region=*, networkEndpointGroup=*, requestId=None)

Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.

Args:
  project: string, Project ID for this request. (required)
  region: string, The name of the region 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).

Returns:
  An object of the form:

    { # Represents an Operation resource.
      #
      # Google Compute Engine has three Operation resources:
      #
      # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
      #
      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "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.
    "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "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.
    "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.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "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" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "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).
          },
        ],
      },
    ],
    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the operation.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
    "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.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the 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 persistent disk that the snapshot was created from.
  }

get(project=*, region=*, networkEndpointGroup=*)

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

Args:
project: string, Project ID for this request. (required)
region: string, The name of the region 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)

Returns:
An object of the form:

{ # Represents a collection of network endpoints.
#
# For more information read Network endpoint groups overview. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21
"size": 42, # [Output only] Number of network endpoints in the network endpoint group.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
"type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now.
"region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.
"networkEndpointType": "A String", # Type of network endpoints in this network endpoint group.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
"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.
"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.
"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".
"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".
},
"subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
"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. [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.
"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.
"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [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.
"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.
},
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"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.
"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".
"service": "A String", # Optional serving service.
#
# The service name must be 1-63 characters long, and comply with RFC1035.
#
# Example value: "default", "my-service".
},
"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.
}

insert(project=*, region=*, body=None, requestId=None)

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)
  region: string, The name of the region 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.
      # 
      # For more information read Network endpoint groups overview. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21
    "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
    "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
    "type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now.
    "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.
    "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
    "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.
      "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.
      "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".
      "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".
    },
    "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
    "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. [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.
      "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.
      "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [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.
    "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.
    },
    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "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.
      "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".
      "service": "A String", # Optional serving service.
          #
          # The service name must be 1-63 characters long, and comply with RFC1035.
          #
          # Example value: "default", "my-service".
    },
    "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.
  }

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

Returns:
  An object of the form:

    { # Represents an Operation resource.
      #
      # Google Compute Engine has three Operation resources:
      #
      # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
      #
      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
    "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.
    "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
    "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.
    "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.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
      {
        "message": "A String", # [Output Only] A human-readable description of the warning code.
        "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" }
          {
            "value": "A String", # [Output Only] A warning data value corresponding to the key.
            "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).
          },
        ],
      },
    ],
    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
    "name": "A String", # [Output Only] Name of the operation.
    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
    "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.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined URL for the 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 persistent disk that the snapshot was created from.
  }

list(project=*, region=*, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)

Retrieves the list of regional network endpoint groups available to the specified project in the given region.

Args:
project: string, Project ID for this request. (required)
region: string, The name of the region where the network endpoint group is located. It should comply with RFC1035. (required)
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.
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)
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.
filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.

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 on resource 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).

Returns:
An object of the form:

{
"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.
"kind": "compute#networkEndpointGroupList", # [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.
"items": [ # A list of NetworkEndpointGroup resources.
{ # Represents a collection of network endpoints.
#
# For more information read Network endpoint groups overview. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21
"size": 42, # [Output only] Number of network endpoints in the network endpoint group.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
"type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now.
"region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.
"networkEndpointType": "A String", # Type of network endpoints in this network endpoint group.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
"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.
"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.
"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".
"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".
},
"subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
"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. [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.
"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.
"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [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.
"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.
},
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"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.
"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".
"service": "A String", # Optional serving service.
#
# The service name must be 1-63 characters long, and comply with RFC1035.
#
# Example value: "default", "my-service".
},
"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.
},
],
"warning": { # [Output Only] Informational warning message.
"message": "A String", # [Output Only] A human-readable description of the warning code.
"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" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
"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).
},
],
},
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}

Compute Engine API . regionNetworkEndpointGroups

Instance Methods

Method Details