As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

NetworkEndpointGroups¶

class google.cloud.compute_v1.services.network_endpoint_groups.NetworkEndpointGroupsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.network_endpoint_groups.transports.base.NetworkEndpointGroupsTransport, typing.Callable[[...], google.cloud.compute_v1.services.network_endpoint_groups.transports.base.NetworkEndpointGroupsTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

The NetworkEndpointGroups API.

Instantiates the network endpoint groups client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,NetworkEndpointGroupsTransport,Callable[..., NetworkEndpointGroupsTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the NetworkEndpointGroupsTransport constructor. If set to None, a transport is chosen automatically. NOTE: “rest” transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library’s source repository.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListNetworkEndpointGroupsRequest, dict]] = None, *, project: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.network_endpoint_groups.pagers.AggregatedListPager[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_aggregated_list():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.AggregatedListNetworkEndpointGroupsRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.aggregated_list(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AggregatedListNetworkEndpointGroupsRequest, dict]) – The request object. A request message for NetworkEndpointGroups.AggregatedList. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.network_endpoint_groups.pagers.AggregatedListPager

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

attach_network_endpoints(request: Optional[Union[google.cloud.compute_v1.types.compute.AttachNetworkEndpointsNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, network_endpoint_groups_attach_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroupsAttachEndpointsRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Attach a list of network endpoints to the specified network endpoint group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_attach_network_endpoints():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.AttachNetworkEndpointsNetworkEndpointGroupRequest(
        network_endpoint_group="network_endpoint_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.attach_network_endpoints(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AttachNetworkEndpointsNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.AttachNetworkEndpoints. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group (str) –
The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.

This corresponds to the network_endpoint_group field on the request instance; if request is provided, this should not be set.
network_endpoint_groups_attach_endpoints_request_resource (google.cloud.compute_v1.types.NetworkEndpointGroupsAttachEndpointsRequest) – The body resource for this request This corresponds to the network_endpoint_groups_attach_endpoints_request_resource field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

attach_network_endpoints_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AttachNetworkEndpointsNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, network_endpoint_groups_attach_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroupsAttachEndpointsRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Attach a list of network endpoints to the specified network endpoint group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_attach_network_endpoints():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.AttachNetworkEndpointsNetworkEndpointGroupRequest(
        network_endpoint_group="network_endpoint_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.attach_network_endpoints(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.AttachNetworkEndpointsNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.AttachNetworkEndpoints. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group (str) –
The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.

This corresponds to the network_endpoint_group field on the request instance; if request is provided, this should not be set.
network_endpoint_groups_attach_endpoints_request_resource (google.cloud.compute_v1.types.NetworkEndpointGroupsAttachEndpointsRequest) – The body resource for this request This corresponds to the network_endpoint_groups_attach_endpoints_request_resource field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteNetworkEndpointGroupRequest(
        network_endpoint_group="network_endpoint_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.Delete. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group (str) –
The name of the network endpoint group to delete. It should comply with RFC1035.

This corresponds to the network_endpoint_group field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_delete():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteNetworkEndpointGroupRequest(
        network_endpoint_group="network_endpoint_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DeleteNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.Delete. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group (str) –
The name of the network endpoint group to delete. It should comply with RFC1035.

This corresponds to the network_endpoint_group field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

detach_network_endpoints(request: Optional[Union[google.cloud.compute_v1.types.compute.DetachNetworkEndpointsNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, network_endpoint_groups_detach_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroupsDetachEndpointsRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

Detach a list of network endpoints from the specified network endpoint group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_detach_network_endpoints():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.DetachNetworkEndpointsNetworkEndpointGroupRequest(
        network_endpoint_group="network_endpoint_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.detach_network_endpoints(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DetachNetworkEndpointsNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.DetachNetworkEndpoints. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group (str) –
The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.

This corresponds to the network_endpoint_group field on the request instance; if request is provided, this should not be set.
network_endpoint_groups_detach_endpoints_request_resource (google.cloud.compute_v1.types.NetworkEndpointGroupsDetachEndpointsRequest) – The body resource for this request This corresponds to the network_endpoint_groups_detach_endpoints_request_resource field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

detach_network_endpoints_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DetachNetworkEndpointsNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, network_endpoint_groups_detach_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroupsDetachEndpointsRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

Detach a list of network endpoints from the specified network endpoint group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_detach_network_endpoints():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.DetachNetworkEndpointsNetworkEndpointGroupRequest(
        network_endpoint_group="network_endpoint_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.detach_network_endpoints(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.DetachNetworkEndpointsNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.DetachNetworkEndpoints. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group (str) –
The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.

This corresponds to the network_endpoint_group field on the request instance; if request is provided, this should not be set.
network_endpoint_groups_detach_endpoints_request_resource (google.cloud.compute_v1.types.NetworkEndpointGroupsDetachEndpointsRequest) – The body resource for this request This corresponds to the network_endpoint_groups_detach_endpoints_request_resource field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkEndpointGroupsClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkEndpointGroupsClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkEndpointGroupsClient

get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.NetworkEndpointGroup[source]¶

Returns the specified network endpoint group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.GetNetworkEndpointGroupRequest(
        network_endpoint_group="network_endpoint_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.get(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.GetNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.Get. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group (str) –
The name of the network endpoint group. It should comply with RFC1035.

This corresponds to the network_endpoint_group field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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, see Network endpoint groups overview.

Return type

google.cloud.compute_v1.types.NetworkEndpointGroup

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroup] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.extended_operation.ExtendedOperation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.InsertNetworkEndpointGroupRequest(
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.InsertNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.Insert. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group_resource (google.cloud.compute_v1.types.NetworkEndpointGroup) – The body resource for this request This corresponds to the network_endpoint_group_resource field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroup] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.Operation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_insert():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.InsertNetworkEndpointGroupRequest(
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.InsertNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.Insert. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group_resource (google.cloud.compute_v1.types.NetworkEndpointGroup) – The body resource for this request This corresponds to the network_endpoint_group_resource field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a extended long-running operation.

Return type

google.api_core.extended_operation.ExtendedOperation

list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListNetworkEndpointGroupsRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.network_endpoint_groups.pagers.ListPager[source]¶

Retrieves the list of network endpoint groups that are located in the specified project and zone.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.ListNetworkEndpointGroupsRequest(
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    page_result = client.list(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ListNetworkEndpointGroupsRequest, dict]) – The request object. A request message for NetworkEndpointGroups.List. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.network_endpoint_groups.pagers.ListPager

list_network_endpoints(request: Optional[Union[google.cloud.compute_v1.types.compute.ListNetworkEndpointsNetworkEndpointGroupsRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, network_endpoint_groups_list_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroupsListEndpointsRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.services.network_endpoint_groups.pagers.ListNetworkEndpointsPager[source]¶

Lists the network endpoints in the specified network endpoint group.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_list_network_endpoints():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.ListNetworkEndpointsNetworkEndpointGroupsRequest(
        network_endpoint_group="network_endpoint_group_value",
        project="project_value",
        zone="zone_value",
    )

    # Make the request
    page_result = client.list_network_endpoints(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.compute_v1.types.ListNetworkEndpointsNetworkEndpointGroupsRequest, dict]) – The request object. A request message for NetworkEndpointGroups.ListNetworkEndpoints. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone where the network endpoint group is located. It should comply with RFC1035.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
network_endpoint_group (str) –
The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.

This corresponds to the network_endpoint_group field on the request instance; if request is provided, this should not be set.
network_endpoint_groups_list_endpoints_request_resource (google.cloud.compute_v1.types.NetworkEndpointGroupsListEndpointsRequest) – The body resource for this request This corresponds to the network_endpoint_groups_list_endpoints_request_resource field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.compute_v1.services.network_endpoint_groups.pagers.ListNetworkEndpointsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

test_iam_permissions(request: Optional[Union[google.cloud.compute_v1.types.compute.TestIamPermissionsNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, test_permissions_request_resource: Optional[google.cloud.compute_v1.types.compute.TestPermissionsRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.compute_v1.types.compute.TestPermissionsResponse[source]¶

Returns permissions that a caller has on the specified resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_test_iam_permissions():
    # Create a client
    client = compute_v1.NetworkEndpointGroupsClient()

    # Initialize request argument(s)
    request = compute_v1.TestIamPermissionsNetworkEndpointGroupRequest(
        project="project_value",
        resource="resource_value",
        zone="zone_value",
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.compute_v1.types.TestIamPermissionsNetworkEndpointGroupRequest, dict]) – The request object. A request message for NetworkEndpointGroups.TestIamPermissions. See the method description for details.
project (str) – Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
zone (str) –
The name of the zone for this request.

This corresponds to the zone field on the request instance; if request is provided, this should not be set.
resource (str) –
Name or id of the resource for this request.

This corresponds to the resource field on the request instance; if request is provided, this should not be set.
test_permissions_request_resource (google.cloud.compute_v1.types.TestPermissionsRequest) – The body resource for this request This corresponds to the test_permissions_request_resource field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Return type

google.cloud.compute_v1.types.TestPermissionsResponse

property transport: google.cloud.compute_v1.services.network_endpoint_groups.transports.base.NetworkEndpointGroupsTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

NetworkEndpointGroupsTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

class google.cloud.compute_v1.services.network_endpoint_groups.pagers.AggregatedListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.NetworkEndpointGroupAggregatedList], request: google.cloud.compute_v1.types.compute.AggregatedListNetworkEndpointGroupsRequest, response: google.cloud.compute_v1.types.compute.NetworkEndpointGroupAggregatedList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through aggregated_list requests.

This class thinly wraps an initial google.cloud.compute_v1.types.NetworkEndpointGroupAggregatedList object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional AggregatedList requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.NetworkEndpointGroupAggregatedList attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.AggregatedListNetworkEndpointGroupsRequest) – The initial request object.
response (google.cloud.compute_v1.types.NetworkEndpointGroupAggregatedList) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.compute_v1.services.network_endpoint_groups.pagers.ListNetworkEndpointsPager(method: Callable[[...], google.cloud.compute_v1.types.compute.NetworkEndpointGroupsListNetworkEndpoints], request: google.cloud.compute_v1.types.compute.ListNetworkEndpointsNetworkEndpointGroupsRequest, response: google.cloud.compute_v1.types.compute.NetworkEndpointGroupsListNetworkEndpoints, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_network_endpoints requests.

This class thinly wraps an initial google.cloud.compute_v1.types.NetworkEndpointGroupsListNetworkEndpoints object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional ListNetworkEndpoints requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.NetworkEndpointGroupsListNetworkEndpoints attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListNetworkEndpointsNetworkEndpointGroupsRequest) – The initial request object.
response (google.cloud.compute_v1.types.NetworkEndpointGroupsListNetworkEndpoints) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.compute_v1.services.network_endpoint_groups.pagers.ListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.NetworkEndpointGroupList], request: google.cloud.compute_v1.types.compute.ListNetworkEndpointGroupsRequest, response: google.cloud.compute_v1.types.compute.NetworkEndpointGroupList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list requests.

This class thinly wraps an initial google.cloud.compute_v1.types.NetworkEndpointGroupList object, and provides an __iter__ method to iterate through its items field.

If there are more pages, the __iter__ method will make additional List requests and continue to iterate through the items field on the corresponding responses.

All the usual google.cloud.compute_v1.types.NetworkEndpointGroupList attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListNetworkEndpointGroupsRequest) – The initial request object.
response (google.cloud.compute_v1.types.NetworkEndpointGroupList) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

NetworkEndpointGroups¶

google-cloud-compute

Navigation

Related Topics