Class NetworkEndpointGroupsClient (0.1.0)

NetworkEndpointGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.network_endpoint_groups.transports.base.NetworkEndpointGroupsTransport]] = 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 NetworkEndpointGroups API.

Properties

transport

Return the transport used by the client instance.

Returns
TypeDescription
NetworkEndpointGroupsTransportThe transport used by the client instance.

Methods

NetworkEndpointGroupsClient

NetworkEndpointGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.network_endpoint_groups.transports.base.NetworkEndpointGroupsTransport]] = 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>)

Instantiate the 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, NetworkEndpointGroupsTransport]

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.

aggregated_list

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

Retrieves the list of network endpoint groups and sorts them by zone.

Parameters
NameDescription
request google.cloud.compute_v1.types.AggregatedListNetworkEndpointGroupsRequest

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.

attach_network_endpoints

attach_network_endpoints(request: Optional[google.cloud.compute_v1.types.compute.AttachNetworkEndpointsNetworkEndpointGroupRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.compute_v1.types.AttachNetworkEndpointsNetworkEndpointGroupRequest

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
TypeDescription
google.cloud.compute_v1.types.OperationRepresents 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 zonalOperations 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 ==)

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

delete

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

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.

Parameters
NameDescription
request google.cloud.compute_v1.types.DeleteNetworkEndpointGroupRequest

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
TypeDescription
google.cloud.compute_v1.types.OperationRepresents 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 zonalOperations 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 ==)

detach_network_endpoints

detach_network_endpoints(request: Optional[google.cloud.compute_v1.types.compute.DetachNetworkEndpointsNetworkEndpointGroupRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request google.cloud.compute_v1.types.DetachNetworkEndpointsNetworkEndpointGroupRequest

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
TypeDescription
google.cloud.compute_v1.types.OperationRepresents 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 zonalOperations 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 ==)

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
NetworkEndpointGroupsClientThe 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
NetworkEndpointGroupsClientThe 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
NetworkEndpointGroupsClientThe constructed client.

get

get(request: Optional[google.cloud.compute_v1.types.compute.GetNetworkEndpointGroupRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group: Optional[str] = None, retry: google.api_core.retry.Retry = <_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 google.cloud.compute_v1.types.GetNetworkEndpointGroupRequest

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
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. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)

insert

insert(request: Optional[google.cloud.compute_v1.types.compute.InsertNetworkEndpointGroupRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, network_endpoint_group_resource: Optional[google.cloud.compute_v1.types.compute.NetworkEndpointGroup] = None, retry: google.api_core.retry.Retry = <_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 google.cloud.compute_v1.types.InsertNetworkEndpointGroupRequest

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
TypeDescription
google.cloud.compute_v1.types.OperationRepresents 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 zonalOperations 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 ==)

list

list(request: Optional[google.cloud.compute_v1.types.compute.ListNetworkEndpointGroupsRequest] = None, *, project: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <_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 and zone.

Parameters
NameDescription
request google.cloud.compute_v1.types.ListNetworkEndpointGroupsRequest

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.

list_network_endpoints

list_network_endpoints(request: Optional[google.cloud.compute_v1.types.compute.ListNetworkEndpointsNetworkEndpointGroupsRequest] = 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: google.api_core.retry.Retry = <_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 google.cloud.compute_v1.types.ListNetworkEndpointsNetworkEndpointGroupsRequest

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.

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.

test_iam_permissions

test_iam_permissions(request: Optional[google.cloud.compute_v1.types.compute.TestIamPermissionsNetworkEndpointGroupRequest] = 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: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
request google.cloud.compute_v1.types.TestIamPermissionsNetworkEndpointGroupRequest

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.