RegionNetworkEndpointGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_network_endpoint_groups.transports.base.RegionNetworkEndpointGroupsTransport]] = 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 RegionNetworkEndpointGroups API.
Properties
transport
Returns the transport used by the client instance.
| Type | Description |
RegionNetworkEndpointGroupsTransport | The transport used by the client instance. |
Methods
RegionNetworkEndpointGroupsClient
RegionNetworkEndpointGroupsClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_network_endpoint_groups.transports.base.RegionNetworkEndpointGroupsTransport]] = 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 region network endpoint groups client.
| Name | Description |
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, RegionNetworkEndpointGroupsTransport]
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 |
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 |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
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_unary
delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteRegionNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, region: 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 it is configured as a backend of a backend service.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteRegionNetworkEndpointGroupRequest, dict]
The request object. A request message for RegionNetworkEndpointGroups.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where the network endpoint group is located. It should comply with RFC1035. This corresponds to the |
network_endpoint_group |
str
The name of the network endpoint group to delete. It should comply with RFC1035. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
RegionNetworkEndpointGroupsClient | The 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.
| Name | Description |
info |
dict
The service account private key info. |
| Type | Description |
RegionNetworkEndpointGroupsClient | The 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.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
RegionNetworkEndpointGroupsClient | The constructed client. |
get
get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetRegionNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, region: 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.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.GetRegionNetworkEndpointGroupRequest, dict]
The request object. A request message for RegionNetworkEndpointGroups.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where the network endpoint group is located. It should comply with RFC1035. This corresponds to the |
network_endpoint_group |
str
The name of the network endpoint group. It should comply with RFC1035. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.NetworkEndpointGroup | Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up 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.
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
insert_unary
insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertRegionNetworkEndpointGroupRequest, dict]] = None, *, project: Optional[str] = None, region: 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.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertRegionNetworkEndpointGroupRequest, dict]
The request object. A request message for RegionNetworkEndpointGroups.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where you want to create the network endpoint group. It should comply with RFC1035. This corresponds to the |
network_endpoint_group_resource |
google.cloud.compute_v1.types.NetworkEndpointGroup
The body resource for this request This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: \* [Global](/compute/docs/reference/rest/v1/globalOperations) \* [Regional](/compute/docs/reference/rest/v1/regionOperations) \* [Zonal](/compute/docs/reference/rest/v1/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. |
list
list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListRegionNetworkEndpointGroupsRequest, dict]] = None, *, project: Optional[str] = None, region: 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 regional network endpoint groups available to the specified project in the given region.
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListRegionNetworkEndpointGroupsRequest, dict]
The request object. A request message for RegionNetworkEndpointGroups.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where the network endpoint group is located. It should comply with RFC1035. This corresponds to the |
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. |
| Type | Description |
google.cloud.compute_v1.services.region_network_endpoint_groups.pagers.ListPager | Iterating 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.