Class TetherAsyncClient (0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
TetherAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.apigeeconnect_v1.services.tether.transports.base.TetherTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from'/workspace/python-apigee-connect/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Tether provides a way for the control plane to send HTTP API requests to services in data planes that runs in a remote datacenter without requiring customers to open firewalls on their runtime plane.
Properties
transport
Returns the transport used by the client instance.
TetherTransport
The transport used by the client instance.
Methods
TetherAsyncClient
TetherAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.apigeeconnect_v1.services.tether.transports.base.TetherTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from'/workspace/python-apigee-connect/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the tether client.
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, .TetherTransport]
The transport to use. If set to None, a transport is chosen automatically.
client_options
ClientOptions
Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
google.auth.exceptions.MutualTlsChannelError
If mutual TLS transport creation failed for any reason.
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.
egress
egress(requests: Optional[AsyncIterator[google.cloud.apigeeconnect_v1.types.tether.EgressResponse]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Egress streams egress requests and responses. Logically, this is not actually a streaming request, but uses streaming as a mechanism to flip the client-server relationship of gRPC so that the server can act as a client. The listener, the RPC server, accepts connections from the dialer, the RPC client. The listener streams http requests and the dialer streams http responses.
requests
AsyncIterator[google.cloud.apigeeconnect_v1.types.EgressResponse ]
The request object AsyncIterator. gRPC response payload for tether.
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.
AsyncIterable[google.cloud.apigeeconnect_v1.types.EgressRequest]
gRPC request payload for tether.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
TetherAsyncClient
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.
info
dict
The service account private key info.
TetherAsyncClient
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.
filename
str
The path to the service account private key json file.
TetherAsyncClient
The constructed client.
get_transport_class
get_transport_class()Returns an appropriate transport class.
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.