Class GlobalNetworkEndpointGroupsClient (1.4.0)

GlobalNetworkEndpointGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.global_network_endpoint_groups.transports.base.GlobalNetworkEndpointGroupsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The GlobalNetworkEndpointGroups API.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
GlobalNetworkEndpointGroupsTransportThe transport used by the client instance.

Methods

GlobalNetworkEndpointGroupsClient

GlobalNetworkEndpointGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.global_network_endpoint_groups.transports.base.GlobalNetworkEndpointGroupsTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the global network endpoint groups client.

Parameters
NameDescription
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 Union[str, GlobalNetworkEndpointGroupsTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

attach_network_endpoints

attach_network_endpoints(request: Optional[Union[google.cloud.compute_v1.types.compute.AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group: Optional[str] = None, global_network_endpoint_groups_attach_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.GlobalNetworkEndpointGroupsAttachEndpointsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Attach a network endpoint to the specified network endpoint group.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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.

global_network_endpoint_groups_attach_endpoints_request_resource google.cloud.compute_v1.types.GlobalNetworkEndpointGroupsAttachEndpointsRequest

The body resource for this request This corresponds to the global_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

attach_network_endpoints_unary

attach_network_endpoints_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group: Optional[str] = None, global_network_endpoint_groups_attach_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.GlobalNetworkEndpointGroupsAttachEndpointsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Attach a network endpoint to the specified network endpoint group.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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.

global_network_endpoint_groups_attach_endpoints_request_resource google.cloud.compute_v1.types.GlobalNetworkEndpointGroupsAttachEndpointsRequest

The body resource for this request This corresponds to the global_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

delete

delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DeleteGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

delete_unary

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DeleteGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

detach_network_endpoints

detach_network_endpoints(request: Optional[Union[google.cloud.compute_v1.types.compute.DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group: Optional[str] = None, global_network_endpoint_groups_detach_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.GlobalNetworkEndpointGroupsDetachEndpointsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Detach the network endpoint from the specified network endpoint group.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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.

global_network_endpoint_groups_detach_endpoints_request_resource google.cloud.compute_v1.types.GlobalNetworkEndpointGroupsDetachEndpointsRequest

The body resource for this request This corresponds to the global_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

detach_network_endpoints_unary

detach_network_endpoints_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group: Optional[str] = None, global_network_endpoint_groups_detach_endpoints_request_resource: Optional[google.cloud.compute_v1.types.compute.GlobalNetworkEndpointGroupsDetachEndpointsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Detach the network endpoint from the specified network endpoint group.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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.

global_network_endpoint_groups_detach_endpoints_request_resource google.cloud.compute_v1.types.GlobalNetworkEndpointGroupsDetachEndpointsRequest

The body resource for this request This corresponds to the global_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
GlobalNetworkEndpointGroupsClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
GlobalNetworkEndpointGroupsClientThe constructed client.

from_service_account_json

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
GlobalNetworkEndpointGroupsClientThe constructed client.

get

get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.GetGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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
TypeDescription
google.cloud.compute_v1.types.NetworkEndpointGroupRepresents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

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

Parameter
NameDescription
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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

insert

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroup] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.InsertGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

insert_unary

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertGlobalNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroup] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.InsertGlobalNetworkEndpointGroupRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

list

list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListGlobalNetworkEndpointGroupsRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.ListGlobalNetworkEndpointGroupsRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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
TypeDescription
google.cloud.compute_v1.services.global_network_endpoint_groups.pagers.ListPagerIterating over this object will yield results and resolve additional pages automatically.

list_network_endpoints

list_network_endpoints(request: Optional[Union[google.cloud.compute_v1.types.compute.ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest, dict]] = None, *, project: Optional[str] = None, network_endpoint_group: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the network endpoints in the specified network endpoint group.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest, dict]

The request object. A request message for GlobalNetworkEndpointGroups.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.

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.

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
TypeDescription
google.cloud.compute_v1.services.global_network_endpoint_groups.pagers.ListNetworkEndpointsPagerIterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.