Class EdgeNetworkClient (0.1.6)

Version 0.1.6

• 0.1.13 (latest)
• 0.1.12

EdgeNetworkClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.edgenetwork_v1.services.edge_network.transports.base.EdgeNetworkTransport]] = 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>)

EdgeNetwork API provides managed, highly available cloud dynamic network configuration service to the GEC customer to enable edge application and network function solutions. This allows the customers to easily define and configure the network setup and property to meet the workload requirement.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
str	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
EdgeNetworkTransport	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
str	The universe domain used by the client instance.

Methods

EdgeNetworkClient

EdgeNetworkClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.edgenetwork_v1.services.edge_network.transports.base.EdgeNetworkTransport]] = 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>)

Instantiates the edge network client.

Parameters
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, EdgeNetworkTransport] The transport to use. If set to None, a transport is chosen automatically.
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.

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

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!

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	.operations_pb2.CancelOperationRequest The request object. Request message for CancelOperation method.
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.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_interconnect_attachment

create_interconnect_attachment(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.CreateInterconnectAttachmentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    interconnect_attachment: typing.Optional[
        google.cloud.edgenetwork_v1.types.resources.InterconnectAttachment
    ] = None,
    interconnect_attachment_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new InterconnectAttachment in a given project and location.

# 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 edgenetwork_v1

def sample_create_interconnect_attachment():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    interconnect_attachment = edgenetwork_v1.InterconnectAttachment()
    interconnect_attachment.name = "name_value"
    interconnect_attachment.interconnect = "interconnect_value"
    interconnect_attachment.vlan_id = 733

    request = edgenetwork_v1.CreateInterconnectAttachmentRequest(
        parent="parent_value",
        interconnect_attachment_id="interconnect_attachment_id_value",
        interconnect_attachment=interconnect_attachment,
    )

    # Make the request
    operation = client.create_interconnect_attachment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.CreateInterconnectAttachmentRequest, dict] The request object. Message for creating a InterconnectAttachment
parent	str Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
interconnect_attachment	google.cloud.edgenetwork_v1.types.InterconnectAttachment Required. The resource being created This corresponds to the interconnect_attachment field on the request instance; if request is provided, this should not be set.
interconnect_attachment_id	str Required. Id of the requesting object If auto-generating Id server-side, remove this field and interconnect_attachment_id from the method_signature of Create RPC This corresponds to the interconnect_attachment_id 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterconnectAttachment Message describing InterconnectAttachment object

create_network

create_network(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.CreateNetworkRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    network: typing.Optional[
        google.cloud.edgenetwork_v1.types.resources.Network
    ] = None,
    network_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new Network in a given project and location.

# 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 edgenetwork_v1

def sample_create_network():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    network = edgenetwork_v1.Network()
    network.name = "name_value"

    request = edgenetwork_v1.CreateNetworkRequest(
        parent="parent_value",
        network_id="network_id_value",
        network=network,
    )

    # Make the request
    operation = client.create_network(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.CreateNetworkRequest, dict] The request object. Message for creating a Network
parent	str Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
network	google.cloud.edgenetwork_v1.types.Network Required. The resource being created This corresponds to the network field on the request instance; if request is provided, this should not be set.
network_id	str Required. Id of the requesting object If auto-generating Id server-side, remove this field and network_id from the method_signature of Create RPC This corresponds to the network_id 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Network Message describing Network object

create_router

create_router(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.CreateRouterRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    router: typing.Optional[google.cloud.edgenetwork_v1.types.resources.Router] = None,
    router_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new Router in a given project and location.

# 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 edgenetwork_v1

def sample_create_router():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    router = edgenetwork_v1.Router()
    router.name = "name_value"
    router.network = "network_value"

    request = edgenetwork_v1.CreateRouterRequest(
        parent="parent_value",
        router_id="router_id_value",
        router=router,
    )

    # Make the request
    operation = client.create_router(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.CreateRouterRequest, dict] The request object. Message for creating a Router
parent	str Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
router	google.cloud.edgenetwork_v1.types.Router Required. The resource being created This corresponds to the router field on the request instance; if request is provided, this should not be set.
router_id	str Required. Id of the requesting object If auto-generating Id server-side, remove this field and router_id from the method_signature of Create RPC This corresponds to the router_id 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Router Message describing Router object

create_subnet

create_subnet(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.CreateSubnetRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    subnet: typing.Optional[google.cloud.edgenetwork_v1.types.resources.Subnet] = None,
    subnet_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new Subnet in a given project and location.

# 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 edgenetwork_v1

def sample_create_subnet():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    subnet = edgenetwork_v1.Subnet()
    subnet.name = "name_value"
    subnet.network = "network_value"

    request = edgenetwork_v1.CreateSubnetRequest(
        parent="parent_value",
        subnet_id="subnet_id_value",
        subnet=subnet,
    )

    # Make the request
    operation = client.create_subnet(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.CreateSubnetRequest, dict] The request object. Message for creating a Subnet
parent	str Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
subnet	google.cloud.edgenetwork_v1.types.Subnet Required. The resource being created This corresponds to the subnet field on the request instance; if request is provided, this should not be set.
subnet_id	str Required. Id of the requesting object If auto-generating Id server-side, remove this field and subnet_id from the method_signature of Create RPC This corresponds to the subnet_id 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Subnet Message describing Subnet object

delete_interconnect_attachment

delete_interconnect_attachment(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.DeleteInterconnectAttachmentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a single InterconnectAttachment.

# 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 edgenetwork_v1

def sample_delete_interconnect_attachment():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.DeleteInterconnectAttachmentRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_interconnect_attachment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.DeleteInterconnectAttachmentRequest, dict] The request object. Message for deleting a InterconnectAttachment
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_network

delete_network(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.DeleteNetworkRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a single Network.

# 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 edgenetwork_v1

def sample_delete_network():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.DeleteNetworkRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_network(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.DeleteNetworkRequest, dict] The request object. Message for deleting a Network
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	.operations_pb2.DeleteOperationRequest The request object. Request message for DeleteOperation method.
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.

delete_router

delete_router(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.DeleteRouterRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a single Router.

# 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 edgenetwork_v1

def sample_delete_router():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.DeleteRouterRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_router(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.DeleteRouterRequest, dict] The request object. Message for deleting a Router
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_subnet

delete_subnet(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.DeleteSubnetRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a single Subnet.

# 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 edgenetwork_v1

def sample_delete_subnet():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.DeleteSubnetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_subnet(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.DeleteSubnetRequest, dict] The request object. Message for deleting a Subnet
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

diagnose_interconnect

diagnose_interconnect(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.DiagnoseInterconnectRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.service.DiagnoseInterconnectResponse

Get the diagnostics of a single interconnect 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 edgenetwork_v1

def sample_diagnose_interconnect():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.DiagnoseInterconnectRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.DiagnoseInterconnectRequest, dict] The request object. Message for requesting the diagnostics of an interconnect within a specific zone.
name	str Required. The name of the interconnect resource. This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.DiagnoseInterconnectResponse	DiagnoseInterconnectResponse contains the current diagnostics for a specific interconnect.

diagnose_network

diagnose_network(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.DiagnoseNetworkRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.service.DiagnoseNetworkResponse

Get the diagnostics of a single network 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 edgenetwork_v1

def sample_diagnose_network():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.DiagnoseNetworkRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.DiagnoseNetworkRequest, dict] The request object. Message for requesting the diagnostics of a network within a specific zone.
name	str Required. The name of the network resource. This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.DiagnoseNetworkResponse	DiagnoseNetworkResponse contains the current status for a specific network.

diagnose_router

diagnose_router(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.DiagnoseRouterRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.service.DiagnoseRouterResponse

Get the diagnostics of a single router 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 edgenetwork_v1

def sample_diagnose_router():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.DiagnoseRouterRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.DiagnoseRouterRequest, dict] The request object. Message for requesting diagnositcs of a router within a specific zone.
name	str Required. The name of the router resource. This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.DiagnoseRouterResponse	DiagnoseRouterResponse contains the current status for a specific router.

from_service_account_file

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

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

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
EdgeNetworkClient	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.

Parameter
Name	Description
info	dict The service account private key info.

Returns
Type	Description
EdgeNetworkClient	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.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
EdgeNetworkClient	The constructed client.

get_interconnect

get_interconnect(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.GetInterconnectRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.resources.Interconnect

Gets details of a single Interconnect.

# 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 edgenetwork_v1

def sample_get_interconnect():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.GetInterconnectRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.GetInterconnectRequest, dict] The request object. Message for getting a Interconnect
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.Interconnect	Message describing Interconnect object

get_interconnect_attachment

get_interconnect_attachment(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.GetInterconnectAttachmentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.resources.InterconnectAttachment

Gets details of a single InterconnectAttachment.

# 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 edgenetwork_v1

def sample_get_interconnect_attachment():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.GetInterconnectAttachmentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.GetInterconnectAttachmentRequest, dict] The request object. Message for getting a InterconnectAttachment
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.InterconnectAttachment	Message describing InterconnectAttachment object

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name	Description
request	.location_pb2.GetLocationRequest The request object. Request message for GetLocation method.
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
Type	Description
.location_pb2.Location	Location object.

get_mtls_endpoint_and_cert_source

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

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.

Parameter
Name	Description
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
Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns
Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_network

get_network(
    request: typing.Optional[
        typing.Union[google.cloud.edgenetwork_v1.types.service.GetNetworkRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.resources.Network

Gets details of a single Network.

# 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 edgenetwork_v1

def sample_get_network():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.GetNetworkRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.GetNetworkRequest, dict] The request object. Message for getting a Network
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.Network	Message describing Network object

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
request	.operations_pb2.GetOperationRequest The request object. Request message for GetOperation method.
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
Type	Description
.operations_pb2.Operation	An Operation object.

get_router

get_router(
    request: typing.Optional[
        typing.Union[google.cloud.edgenetwork_v1.types.service.GetRouterRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.resources.Router

Gets details of a single Router.

# 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 edgenetwork_v1

def sample_get_router():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.GetRouterRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.GetRouterRequest, dict] The request object. Message for getting a Router
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.Router	Message describing Router object

get_subnet

get_subnet(
    request: typing.Optional[
        typing.Union[google.cloud.edgenetwork_v1.types.service.GetSubnetRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.resources.Subnet

Gets details of a single Subnet.

# 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 edgenetwork_v1

def sample_get_subnet():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.GetSubnetRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.GetSubnetRequest, dict] The request object. Message for getting a Subnet
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.Subnet	Message describing Subnet object

get_zone

get_zone(
    request: typing.Optional[
        typing.Union[google.cloud.edgenetwork_v1.types.service.GetZoneRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.resources.Zone

Gets details of a single 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 edgenetwork_v1

def sample_get_zone():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.GetZoneRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.GetZoneRequest, dict] The request object. Message for getting a Zone
name	str Required. Name of the resource This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.Zone	A Google Edge Cloud zone.

initialize_zone

initialize_zone(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.InitializeZoneRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.types.service.InitializeZoneResponse

InitializeZone will initialize resources for a zone in a project.

# 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 edgenetwork_v1

def sample_initialize_zone():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.InitializeZoneRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.InitializeZoneRequest, dict] The request object. Message for initializing a specified zone
name	str Required. The name of the zone resource. This corresponds to the name 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
Type	Description
google.cloud.edgenetwork_v1.types.InitializeZoneResponse	The response of initializing a zone

interconnect_attachment_path

interconnect_attachment_path(
    project: str, location: str, zone: str, interconnect_attachment: str
) -> str

Returns a fully-qualified interconnect_attachment string.

interconnect_path

interconnect_path(project: str, location: str, zone: str, interconnect: str) -> str

Returns a fully-qualified interconnect string.

list_interconnect_attachments

list_interconnect_attachments(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.ListInterconnectAttachmentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.edgenetwork_v1.services.edge_network.pagers.ListInterconnectAttachmentsPager
)

Lists InterconnectAttachments in a given project and location.

# 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 edgenetwork_v1

def sample_list_interconnect_attachments():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.ListInterconnectAttachmentsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.ListInterconnectAttachmentsRequest, dict] The request object. Message for requesting list of InterconnectAttachments
parent	str Required. Parent value for ListInterconnectAttachmentsRequest This corresponds to the parent 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
Type	Description
google.cloud.edgenetwork_v1.services.edge_network.pagers.ListInterconnectAttachmentsPager	Message for response to listing InterconnectAttachments Iterating over this object will yield results and resolve additional pages automatically.

list_interconnects

list_interconnects(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.ListInterconnectsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.services.edge_network.pagers.ListInterconnectsPager

Lists Interconnects in a given project and location.

# 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 edgenetwork_v1

def sample_list_interconnects():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.ListInterconnectsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.ListInterconnectsRequest, dict] The request object. Message for requesting list of Interconnects
parent	str Required. Parent value for ListInterconnectsRequest This corresponds to the parent 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
Type	Description
google.cloud.edgenetwork_v1.services.edge_network.pagers.ListInterconnectsPager	Message for response to listing Interconnects Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name	Description
request	.location_pb2.ListLocationsRequest The request object. Request message for ListLocations method.
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
Type	Description
.location_pb2.ListLocationsResponse	Response message for ListLocations method.

list_networks

list_networks(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.ListNetworksRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.services.edge_network.pagers.ListNetworksPager

Lists Networks in a given project and location.

# 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 edgenetwork_v1

def sample_list_networks():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.ListNetworksRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.ListNetworksRequest, dict] The request object. Message for requesting list of Networks
parent	str Required. Parent value for ListNetworksRequest This corresponds to the parent 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
Type	Description
google.cloud.edgenetwork_v1.services.edge_network.pagers.ListNetworksPager	Message for response to listing Networks Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name	Description
request	.operations_pb2.ListOperationsRequest The request object. Request message for ListOperations method.
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
Type	Description
.operations_pb2.ListOperationsResponse	Response message for ListOperations method.

list_routers

list_routers(
    request: typing.Optional[
        typing.Union[google.cloud.edgenetwork_v1.types.service.ListRoutersRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.services.edge_network.pagers.ListRoutersPager

Lists Routers in a given project and location.

# 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 edgenetwork_v1

def sample_list_routers():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.ListRoutersRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.ListRoutersRequest, dict] The request object. Message for requesting list of Routers
parent	str Required. Parent value for ListRoutersRequest This corresponds to the parent 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
Type	Description
google.cloud.edgenetwork_v1.services.edge_network.pagers.ListRoutersPager	Message for response to listing Routers Iterating over this object will yield results and resolve additional pages automatically.

list_subnets

list_subnets(
    request: typing.Optional[
        typing.Union[google.cloud.edgenetwork_v1.types.service.ListSubnetsRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.services.edge_network.pagers.ListSubnetsPager

Lists Subnets in a given project and location.

# 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 edgenetwork_v1

def sample_list_subnets():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.ListSubnetsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.ListSubnetsRequest, dict] The request object. Message for requesting list of Subnets
parent	str Required. Parent value for ListSubnetsRequest This corresponds to the parent 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
Type	Description
google.cloud.edgenetwork_v1.services.edge_network.pagers.ListSubnetsPager	Message for response to listing Subnets Iterating over this object will yield results and resolve additional pages automatically.

list_zones

list_zones(
    request: typing.Optional[
        typing.Union[google.cloud.edgenetwork_v1.types.service.ListZonesRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.edgenetwork_v1.services.edge_network.pagers.ListZonesPager

Lists Zones in a given project and location.

# 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 edgenetwork_v1

def sample_list_zones():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    request = edgenetwork_v1.ListZonesRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.ListZonesRequest, dict] The request object. Message for requesting list of Zones
parent	str Required. Parent value for ListZonesRequest This corresponds to the parent 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
Type	Description
google.cloud.edgenetwork_v1.services.edge_network.pagers.ListZonesPager	Message for response to listing Zones Iterating over this object will yield results and resolve additional pages automatically.

network_path

network_path(project: str, location: str, zone: str, network: str) -> str

Returns a fully-qualified network string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_interconnect_attachment_path

parse_interconnect_attachment_path(path: str) -> typing.Dict[str, str]

Parses a interconnect_attachment path into its component segments.

parse_interconnect_path

parse_interconnect_path(path: str) -> typing.Dict[str, str]

Parses a interconnect path into its component segments.

parse_network_path

parse_network_path(path: str) -> typing.Dict[str, str]

Parses a network path into its component segments.

parse_router_path

parse_router_path(path: str) -> typing.Dict[str, str]

Parses a router path into its component segments.

parse_subnet_path

parse_subnet_path(path: str) -> typing.Dict[str, str]

Parses a subnet path into its component segments.

parse_zone_path

parse_zone_path(path: str) -> typing.Dict[str, str]

Parses a zone path into its component segments.

router_path

router_path(project: str, location: str, zone: str, router: str) -> str

Returns a fully-qualified router string.

subnet_path

subnet_path(project: str, location: str, zone: str, subnet: str) -> str

Returns a fully-qualified subnet string.

update_router

update_router(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.UpdateRouterRequest, dict
        ]
    ] = None,
    *,
    router: typing.Optional[google.cloud.edgenetwork_v1.types.resources.Router] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single Router.

# 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 edgenetwork_v1

def sample_update_router():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    router = edgenetwork_v1.Router()
    router.name = "name_value"
    router.network = "network_value"

    request = edgenetwork_v1.UpdateRouterRequest(
        router=router,
    )

    # Make the request
    operation = client.update_router(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.UpdateRouterRequest, dict] The request object. Message for updating a Router
router	google.cloud.edgenetwork_v1.types.Router Required. The resource being updated This corresponds to the router field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask Required. Field mask is used to specify the fields to be overwritten in the Router resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the update_mask 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Router Message describing Router object

update_subnet

update_subnet(
    request: typing.Optional[
        typing.Union[
            google.cloud.edgenetwork_v1.types.service.UpdateSubnetRequest, dict
        ]
    ] = None,
    *,
    subnet: typing.Optional[google.cloud.edgenetwork_v1.types.resources.Subnet] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single Subnet.

# 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 edgenetwork_v1

def sample_update_subnet():
    # Create a client
    client = edgenetwork_v1.EdgeNetworkClient()

    # Initialize request argument(s)
    subnet = edgenetwork_v1.Subnet()
    subnet.name = "name_value"
    subnet.network = "network_value"

    request = edgenetwork_v1.UpdateSubnetRequest(
        subnet=subnet,
    )

    # Make the request
    operation = client.update_subnet(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.edgenetwork_v1.types.UpdateSubnetRequest, dict] The request object. Message for updating a Subnet
subnet	google.cloud.edgenetwork_v1.types.Subnet Required. The resource being updated This corresponds to the subnet field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask Required. Field mask is used to specify the fields to be overwritten in the Subnet resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the update_mask 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
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Subnet Message describing Subnet object

zone_path

zone_path(project: str, location: str, zone: str) -> str

Returns a fully-qualified zone string.