ApiGatewayService¶
- class google.cloud.apigateway_v1.services.api_gateway_service.ApiGatewayServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.apigateway_v1.services.api_gateway_service.transports.base.ApiGatewayServiceTransport, typing.Callable[[...], google.cloud.apigateway_v1.services.api_gateway_service.transports.base.ApiGatewayServiceTransport]]] = 'grpc_asyncio', client_options: typing.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>)[source]¶
The API Gateway Service is the interface for managing API Gateways.
Instantiates the api gateway service async client.
- Parameters
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 (Optional[Union[str,ApiGatewayServiceTransport,Callable[..., ApiGatewayServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the ApiGatewayServiceTransport constructor. 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 whentransport
is not explicitly provided. Only if this property is not set andtransport
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 thatapi_endpoint
property still takes precedence; anduniverse_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- static api_config_path(project: str, api: str, api_config: str) str ¶
Returns a fully-qualified api_config string.
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- async create_api(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.CreateApiRequest, dict]] = None, *, parent: Optional[str] = None, api: Optional[google.cloud.apigateway_v1.types.apigateway.Api] = None, api_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates a new Api 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 apigateway_v1 async def sample_create_api(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.CreateApiRequest( parent="parent_value", api_id="api_id_value", ) # Make the request operation = client.create_api(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.CreateApiRequest, dict]]) – The request object. Request message for ApiGatewayService.CreateApi
parent (
str
) –Required. Parent resource of the API, of the form:
projects/*/locations/global
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.api (
google.cloud.apigateway_v1.types.Api
) – Required. API resource. This corresponds to theapi
field on therequest
instance; ifrequest
is provided, this should not be set.api_id (
str
) –Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
This corresponds to the
api_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.apigateway_v1.types.Api
An API that can be served by one or more Gateways.- Return type
- async create_api_config(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.CreateApiConfigRequest, dict]] = None, *, parent: Optional[str] = None, api_config: Optional[google.cloud.apigateway_v1.types.apigateway.ApiConfig] = None, api_config_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates a new ApiConfig 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 apigateway_v1 async def sample_create_api_config(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.CreateApiConfigRequest( parent="parent_value", api_config_id="api_config_id_value", ) # Make the request operation = client.create_api_config(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.CreateApiConfigRequest, dict]]) – The request object. Request message for ApiGatewayService.CreateApiConfig
parent (
str
) –Required. Parent resource of the API Config, of the form:
projects/*/locations/global/apis/*
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.api_config (
google.cloud.apigateway_v1.types.ApiConfig
) – Required. API resource. This corresponds to theapi_config
field on therequest
instance; ifrequest
is provided, this should not be set.api_config_id (
str
) –Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.
This corresponds to the
api_config_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.apigateway_v1.types.ApiConfig
An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.
- The result type for the operation will be
- Return type
- async create_gateway(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.CreateGatewayRequest, dict]] = None, *, parent: Optional[str] = None, gateway: Optional[google.cloud.apigateway_v1.types.apigateway.Gateway] = None, gateway_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates a new Gateway 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 apigateway_v1 async def sample_create_gateway(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) gateway = apigateway_v1.Gateway() gateway.api_config = "api_config_value" request = apigateway_v1.CreateGatewayRequest( parent="parent_value", gateway_id="gateway_id_value", gateway=gateway, ) # Make the request operation = client.create_gateway(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.CreateGatewayRequest, dict]]) – The request object. Request message for ApiGatewayService.CreateGateway
parent (
str
) –Required. Parent resource of the Gateway, of the form:
projects/*/locations/*
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.gateway (
google.cloud.apigateway_v1.types.Gateway
) – Required. Gateway resource. This corresponds to thegateway
field on therequest
instance; ifrequest
is provided, this should not be set.gateway_id (
str
) –Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
This corresponds to the
gateway_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.apigateway_v1.types.Gateway
A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
- The result type for the operation will be
- Return type
- async delete_api(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.DeleteApiRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Deletes a single Api.
# 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 apigateway_v1 async def sample_delete_api(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.DeleteApiRequest( name="name_value", ) # Make the request operation = client.delete_api(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.DeleteApiRequest, dict]]) – The request object. Request message for ApiGatewayService.DeleteApi
name (
str
) –Required. Resource name of the form:
projects/*/locations/global/apis/*
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
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);
}
- The result type for the operation will be
- Return type
- async delete_api_config(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.DeleteApiConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Deletes a single ApiConfig.
# 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 apigateway_v1 async def sample_delete_api_config(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.DeleteApiConfigRequest( name="name_value", ) # Make the request operation = client.delete_api_config(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.DeleteApiConfigRequest, dict]]) – The request object. Request message for ApiGatewayService.DeleteApiConfig
name (
str
) –Required. Resource name of the form:
projects/*/locations/global/apis/*/configs/*
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
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);
}
- The result type for the operation will be
- Return type
- async delete_gateway(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.DeleteGatewayRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Deletes a single Gateway.
# 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 apigateway_v1 async def sample_delete_gateway(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.DeleteGatewayRequest( name="name_value", ) # Make the request operation = client.delete_gateway(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.DeleteGatewayRequest, dict]]) – The request object. Request message for ApiGatewayService.DeleteGateway
name (
str
) –Required. Resource name of the form:
projects/*/locations/*/gateways/*
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
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);
}
- The result type for the operation will be
- Return type
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- static gateway_path(project: str, location: str, gateway: str) str ¶
Returns a fully-qualified gateway string.
- async get_api(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.GetApiRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.types.apigateway.Api [source]¶
Gets details of a single Api.
# 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 apigateway_v1 async def sample_get_api(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.GetApiRequest( name="name_value", ) # Make the request response = await client.get_api(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.GetApiRequest, dict]]) – The request object. Request message for ApiGatewayService.GetApi
name (
str
) –Required. Resource name of the form:
projects/*/locations/global/apis/*
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An API that can be served by one or more Gateways.
- Return type
- async get_api_config(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.GetApiConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.types.apigateway.ApiConfig [source]¶
Gets details of a single ApiConfig.
# 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 apigateway_v1 async def sample_get_api_config(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.GetApiConfigRequest( name="name_value", ) # Make the request response = await client.get_api_config(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.GetApiConfigRequest, dict]]) – The request object. Request message for ApiGatewayService.GetApiConfig
name (
str
) –Required. Resource name of the form:
projects/*/locations/global/apis/*/configs/*
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.
- Return type
- async get_gateway(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.GetGatewayRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.types.apigateway.Gateway [source]¶
Gets details of a single Gateway.
# 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 apigateway_v1 async def sample_get_gateway(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.GetGatewayRequest( name="name_value", ) # Make the request response = await client.get_gateway(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.GetGatewayRequest, dict]]) – The request object. Request message for ApiGatewayService.GetGateway
name (
str
) –Required. Resource name of the form:
projects/*/locations/*/gateways/*
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
- Return type
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- classmethod get_transport_class(label: Optional[str] = None) Type[google.cloud.apigateway_v1.services.api_gateway_service.transports.base.ApiGatewayServiceTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- async list_api_configs(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.ListApiConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsAsyncPager [source]¶
Lists ApiConfigs 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 apigateway_v1 async def sample_list_api_configs(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.ListApiConfigsRequest( parent="parent_value", ) # Make the request page_result = client.list_api_configs(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.ListApiConfigsRequest, dict]]) – The request object. Request message for ApiGatewayService.ListApiConfigs
parent (
str
) –Required. Parent resource of the API Config, of the form:
projects/*/locations/global/apis/*
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for ApiGatewayService.ListApiConfigs Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsAsyncPager
- async list_apis(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.ListApisRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisAsyncPager [source]¶
Lists Apis 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 apigateway_v1 async def sample_list_apis(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.ListApisRequest( parent="parent_value", ) # Make the request page_result = client.list_apis(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.ListApisRequest, dict]]) – The request object. Request message for ApiGatewayService.ListApis
parent (
str
) –Required. Parent resource of the API, of the form:
projects/*/locations/global
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for ApiGatewayService.ListApis Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisAsyncPager
- async list_gateways(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.ListGatewaysRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysAsyncPager [source]¶
Lists Gateways 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 apigateway_v1 async def sample_list_gateways(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.ListGatewaysRequest( parent="parent_value", ) # Make the request page_result = client.list_gateways(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.ListGatewaysRequest, dict]]) – The request object. Request message for ApiGatewayService.ListGateways
parent (
str
) –Required. Parent resource of the Gateway, of the form:
projects/*/locations/*
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
Response message for ApiGatewayService.ListGateways Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysAsyncPager
- static parse_api_config_path(path: str) Dict[str, str] ¶
Parses a api_config path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- static parse_gateway_path(path: str) Dict[str, str] ¶
Parses a gateway path into its component segments.
- static parse_managed_service_path(path: str) Dict[str, str] ¶
Parses a managed_service path into its component segments.
- static parse_service_account_path(path: str) Dict[str, str] ¶
Parses a service_account path into its component segments.
- static parse_service_path(path: str) Dict[str, str] ¶
Parses a service path into its component segments.
- static service_account_path(project: str, service_account: str) str ¶
Returns a fully-qualified service_account string.
- property transport: google.cloud.apigateway_v1.services.api_gateway_service.transports.base.ApiGatewayServiceTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
ApiGatewayServiceTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
- The universe domain used
by the client instance.
- Return type
- async update_api(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.UpdateApiRequest, dict]] = None, *, api: Optional[google.cloud.apigateway_v1.types.apigateway.Api] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Updates the parameters of a single Api.
# 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 apigateway_v1 async def sample_update_api(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.UpdateApiRequest( ) # Make the request operation = client.update_api(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.UpdateApiRequest, dict]]) – The request object. Request message for ApiGatewayService.UpdateApi
api (
google.cloud.apigateway_v1.types.Api
) – Required. API resource. This corresponds to theapi
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –Field mask is used to specify the fields to be overwritten in the Api 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 therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.apigateway_v1.types.Api
An API that can be served by one or more Gateways.- Return type
- async update_api_config(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.UpdateApiConfigRequest, dict]] = None, *, api_config: Optional[google.cloud.apigateway_v1.types.apigateway.ApiConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Updates the parameters of a single ApiConfig.
# 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 apigateway_v1 async def sample_update_api_config(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) request = apigateway_v1.UpdateApiConfigRequest( ) # Make the request operation = client.update_api_config(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.UpdateApiConfigRequest, dict]]) – The request object. Request message for ApiGatewayService.UpdateApiConfig
api_config (
google.cloud.apigateway_v1.types.ApiConfig
) – Required. API Config resource. This corresponds to theapi_config
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –Field mask is used to specify the fields to be overwritten in the ApiConfig 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 therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.apigateway_v1.types.ApiConfig
An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.
- The result type for the operation will be
- Return type
- async update_gateway(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.UpdateGatewayRequest, dict]] = None, *, gateway: Optional[google.cloud.apigateway_v1.types.apigateway.Gateway] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Updates the parameters of a single Gateway.
# 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 apigateway_v1 async def sample_update_gateway(): # Create a client client = apigateway_v1.ApiGatewayServiceAsyncClient() # Initialize request argument(s) gateway = apigateway_v1.Gateway() gateway.api_config = "api_config_value" request = apigateway_v1.UpdateGatewayRequest( gateway=gateway, ) # Make the request operation = client.update_gateway(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.apigateway_v1.types.UpdateGatewayRequest, dict]]) – The request object. Request message for ApiGatewayService.UpdateGateway
gateway (
google.cloud.apigateway_v1.types.Gateway
) – Required. Gateway resource. This corresponds to thegateway
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –Field mask is used to specify the fields to be overwritten in the Gateway 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 therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry_async.AsyncRetry) – 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
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.apigateway_v1.types.Gateway
A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
- The result type for the operation will be
- Return type
- class google.cloud.apigateway_v1.services.api_gateway_service.ApiGatewayServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.apigateway_v1.services.api_gateway_service.transports.base.ApiGatewayServiceTransport, typing.Callable[[...], google.cloud.apigateway_v1.services.api_gateway_service.transports.base.ApiGatewayServiceTransport]]] = 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>)[source]¶
The API Gateway Service is the interface for managing API Gateways.
Instantiates the api gateway service client.
- Parameters
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 (Optional[Union[str,ApiGatewayServiceTransport,Callable[..., ApiGatewayServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the ApiGatewayServiceTransport constructor. 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 whentransport
is not explicitly provided. Only if this property is not set andtransport
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 theapi_endpoint
property still takes precedence; anduniverse_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
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!
- static api_config_path(project: str, api: str, api_config: str) str [source]¶
Returns a fully-qualified api_config string.
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- create_api(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.CreateApiRequest, dict]] = None, *, parent: Optional[str] = None, api: Optional[google.cloud.apigateway_v1.types.apigateway.Api] = None, api_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates a new Api 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 apigateway_v1 def sample_create_api(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.CreateApiRequest( parent="parent_value", api_id="api_id_value", ) # Make the request operation = client.create_api(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.CreateApiRequest, dict]) – The request object. Request message for ApiGatewayService.CreateApi
parent (str) –
Required. Parent resource of the API, of the form:
projects/*/locations/global
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.api (google.cloud.apigateway_v1.types.Api) – Required. API resource. This corresponds to the
api
field on therequest
instance; ifrequest
is provided, this should not be set.api_id (str) –
Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
This corresponds to the
api_id
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.apigateway_v1.types.Api
An API that can be served by one or more Gateways.- Return type
- create_api_config(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.CreateApiConfigRequest, dict]] = None, *, parent: Optional[str] = None, api_config: Optional[google.cloud.apigateway_v1.types.apigateway.ApiConfig] = None, api_config_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates a new ApiConfig 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 apigateway_v1 def sample_create_api_config(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.CreateApiConfigRequest( parent="parent_value", api_config_id="api_config_id_value", ) # Make the request operation = client.create_api_config(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.CreateApiConfigRequest, dict]) – The request object. Request message for ApiGatewayService.CreateApiConfig
parent (str) –
Required. Parent resource of the API Config, of the form:
projects/*/locations/global/apis/*
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.api_config (google.cloud.apigateway_v1.types.ApiConfig) – Required. API resource. This corresponds to the
api_config
field on therequest
instance; ifrequest
is provided, this should not be set.api_config_id (str) –
Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.
This corresponds to the
api_config_id
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.apigateway_v1.types.ApiConfig
An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.
- The result type for the operation will be
- Return type
- create_gateway(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.CreateGatewayRequest, dict]] = None, *, parent: Optional[str] = None, gateway: Optional[google.cloud.apigateway_v1.types.apigateway.Gateway] = None, gateway_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates a new Gateway 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 apigateway_v1 def sample_create_gateway(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) gateway = apigateway_v1.Gateway() gateway.api_config = "api_config_value" request = apigateway_v1.CreateGatewayRequest( parent="parent_value", gateway_id="gateway_id_value", gateway=gateway, ) # Make the request operation = client.create_gateway(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.CreateGatewayRequest, dict]) – The request object. Request message for ApiGatewayService.CreateGateway
parent (str) –
Required. Parent resource of the Gateway, of the form:
projects/*/locations/*
This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.gateway (google.cloud.apigateway_v1.types.Gateway) – Required. Gateway resource. This corresponds to the
gateway
field on therequest
instance; ifrequest
is provided, this should not be set.gateway_id (str) –
Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
This corresponds to the
gateway_id
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.apigateway_v1.types.Gateway
A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
- The result type for the operation will be
- Return type
- delete_api(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.DeleteApiRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Deletes a single Api.
# 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 apigateway_v1 def sample_delete_api(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.DeleteApiRequest( name="name_value", ) # Make the request operation = client.delete_api(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.DeleteApiRequest, dict]) – The request object. Request message for ApiGatewayService.DeleteApi
name (str) –
Required. Resource name of the form:
projects/*/locations/global/apis/*
This corresponds to the
name
field on therequest
instance; ifrequest
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
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);
}
- The result type for the operation will be
- Return type
- delete_api_config(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.DeleteApiConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Deletes a single ApiConfig.
# 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 apigateway_v1 def sample_delete_api_config(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.DeleteApiConfigRequest( name="name_value", ) # Make the request operation = client.delete_api_config(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.DeleteApiConfigRequest, dict]) – The request object. Request message for ApiGatewayService.DeleteApiConfig
name (str) –
Required. Resource name of the form:
projects/*/locations/global/apis/*/configs/*
This corresponds to the
name
field on therequest
instance; ifrequest
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
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);
}
- The result type for the operation will be
- Return type
- delete_gateway(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.DeleteGatewayRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Deletes a single Gateway.
# 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 apigateway_v1 def sample_delete_gateway(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.DeleteGatewayRequest( name="name_value", ) # Make the request operation = client.delete_gateway(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.DeleteGatewayRequest, dict]) – The request object. Request message for ApiGatewayService.DeleteGateway
name (str) –
Required. Resource name of the form:
projects/*/locations/*/gateways/*
This corresponds to the
name
field on therequest
instance; ifrequest
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
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);
}
- The result type for the operation will be
- Return type
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- static gateway_path(project: str, location: str, gateway: str) str [source]¶
Returns a fully-qualified gateway string.
- get_api(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.GetApiRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.types.apigateway.Api [source]¶
Gets details of a single Api.
# 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 apigateway_v1 def sample_get_api(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.GetApiRequest( name="name_value", ) # Make the request response = client.get_api(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.GetApiRequest, dict]) – The request object. Request message for ApiGatewayService.GetApi
name (str) –
Required. Resource name of the form:
projects/*/locations/global/apis/*
This corresponds to the
name
field on therequest
instance; ifrequest
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
An API that can be served by one or more Gateways.
- Return type
- get_api_config(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.GetApiConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.types.apigateway.ApiConfig [source]¶
Gets details of a single ApiConfig.
# 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 apigateway_v1 def sample_get_api_config(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.GetApiConfigRequest( name="name_value", ) # Make the request response = client.get_api_config(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.GetApiConfigRequest, dict]) – The request object. Request message for ApiGatewayService.GetApiConfig
name (str) –
Required. Resource name of the form:
projects/*/locations/global/apis/*/configs/*
This corresponds to the
name
field on therequest
instance; ifrequest
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
An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.
- Return type
- get_gateway(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.GetGatewayRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.types.apigateway.Gateway [source]¶
Gets details of a single Gateway.
# 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 apigateway_v1 def sample_get_gateway(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.GetGatewayRequest( name="name_value", ) # Make the request response = client.get_gateway(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.GetGatewayRequest, dict]) – The request object. Request message for ApiGatewayService.GetGateway
name (str) –
Required. Resource name of the form:
projects/*/locations/*/gateways/*
This corresponds to the
name
field on therequest
instance; ifrequest
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
A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
- Return type
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- list_api_configs(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.ListApiConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsPager [source]¶
Lists ApiConfigs 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 apigateway_v1 def sample_list_api_configs(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.ListApiConfigsRequest( parent="parent_value", ) # Make the request page_result = client.list_api_configs(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.ListApiConfigsRequest, dict]) – The request object. Request message for ApiGatewayService.ListApiConfigs
parent (str) –
Required. Parent resource of the API Config, of the form:
projects/*/locations/global/apis/*
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for ApiGatewayService.ListApiConfigs Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsPager
- list_apis(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.ListApisRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisPager [source]¶
Lists Apis 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 apigateway_v1 def sample_list_apis(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.ListApisRequest( parent="parent_value", ) # Make the request page_result = client.list_apis(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.ListApisRequest, dict]) – The request object. Request message for ApiGatewayService.ListApis
parent (str) –
Required. Parent resource of the API, of the form:
projects/*/locations/global
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for ApiGatewayService.ListApis Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisPager
- list_gateways(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.ListGatewaysRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysPager [source]¶
Lists Gateways 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 apigateway_v1 def sample_list_gateways(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.ListGatewaysRequest( parent="parent_value", ) # Make the request page_result = client.list_gateways(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.ListGatewaysRequest, dict]) – The request object. Request message for ApiGatewayService.ListGateways
parent (str) –
Required. Parent resource of the Gateway, of the form:
projects/*/locations/*
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response message for ApiGatewayService.ListGateways Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysPager
- static managed_service_path(service: str) str [source]¶
Returns a fully-qualified managed_service string.
- static parse_api_config_path(path: str) Dict[str, str] [source]¶
Parses a api_config path into its component segments.
- static parse_api_path(path: str) Dict[str, str] [source]¶
Parses a api path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- static parse_gateway_path(path: str) Dict[str, str] [source]¶
Parses a gateway path into its component segments.
- static parse_managed_service_path(path: str) Dict[str, str] [source]¶
Parses a managed_service path into its component segments.
- static parse_service_account_path(path: str) Dict[str, str] [source]¶
Parses a service_account path into its component segments.
- static parse_service_path(path: str) Dict[str, str] [source]¶
Parses a service path into its component segments.
- static service_account_path(project: str, service_account: str) str [source]¶
Returns a fully-qualified service_account string.
- static service_path(service: str, config: str) str [source]¶
Returns a fully-qualified service string.
- property transport: google.cloud.apigateway_v1.services.api_gateway_service.transports.base.ApiGatewayServiceTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
ApiGatewayServiceTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
The universe domain used by the client instance.
- Return type
- update_api(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.UpdateApiRequest, dict]] = None, *, api: Optional[google.cloud.apigateway_v1.types.apigateway.Api] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Updates the parameters of a single Api.
# 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 apigateway_v1 def sample_update_api(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.UpdateApiRequest( ) # Make the request operation = client.update_api(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.UpdateApiRequest, dict]) – The request object. Request message for ApiGatewayService.UpdateApi
api (google.cloud.apigateway_v1.types.Api) – Required. API resource. This corresponds to the
api
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the Api 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 therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.apigateway_v1.types.Api
An API that can be served by one or more Gateways.- Return type
- update_api_config(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.UpdateApiConfigRequest, dict]] = None, *, api_config: Optional[google.cloud.apigateway_v1.types.apigateway.ApiConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Updates the parameters of a single ApiConfig.
# 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 apigateway_v1 def sample_update_api_config(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) request = apigateway_v1.UpdateApiConfigRequest( ) # Make the request operation = client.update_api_config(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.UpdateApiConfigRequest, dict]) – The request object. Request message for ApiGatewayService.UpdateApiConfig
api_config (google.cloud.apigateway_v1.types.ApiConfig) – Required. API Config resource. This corresponds to the
api_config
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the ApiConfig 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 therequest
instance; ifrequest
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
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.apigateway_v1.types.ApiConfig
An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.
- The result type for the operation will be
- Return type
- update_gateway(request: Optional[Union[google.cloud.apigateway_v1.types.apigateway.UpdateGatewayRequest, dict]] = None, *, gateway: Optional[google.cloud.apigateway_v1.types.apigateway.Gateway] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Updates the parameters of a single Gateway.
# 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 apigateway_v1 def sample_update_gateway(): # Create a client client = apigateway_v1.ApiGatewayServiceClient() # Initialize request argument(s) gateway = apigateway_v1.Gateway() gateway.api_config = "api_config_value" request = apigateway_v1.UpdateGatewayRequest( gateway=gateway, ) # Make the request operation = client.update_gateway(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
request (Union[google.cloud.apigateway_v1.types.UpdateGatewayRequest, dict]) – The request object. Request message for ApiGatewayService.UpdateGateway
gateway (google.cloud.apigateway_v1.types.Gateway) – Required. Gateway resource. This corresponds to the
gateway
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Field mask is used to specify the fields to be overwritten in the Gateway 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 therequest
instance; ifrequest
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
An object representing a long-running operation.
- The result type for the operation will be
google.cloud.apigateway_v1.types.Gateway
A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
- The result type for the operation will be
- Return type
- class google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.apigateway_v1.types.apigateway.ListApiConfigsResponse]], request: google.cloud.apigateway_v1.types.apigateway.ListApiConfigsRequest, response: google.cloud.apigateway_v1.types.apigateway.ListApiConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_api_configs
requests.This class thinly wraps an initial
google.cloud.apigateway_v1.types.ListApiConfigsResponse
object, and provides an__aiter__
method to iterate through itsapi_configs
field.If there are more pages, the
__aiter__
method will make additionalListApiConfigs
requests and continue to iterate through theapi_configs
field on the corresponding responses.All the usual
google.cloud.apigateway_v1.types.ListApiConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.apigateway_v1.types.ListApiConfigsRequest) – The initial request object.
response (google.cloud.apigateway_v1.types.ListApiConfigsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApiConfigsPager(method: Callable[[...], google.cloud.apigateway_v1.types.apigateway.ListApiConfigsResponse], request: google.cloud.apigateway_v1.types.apigateway.ListApiConfigsRequest, response: google.cloud.apigateway_v1.types.apigateway.ListApiConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_api_configs
requests.This class thinly wraps an initial
google.cloud.apigateway_v1.types.ListApiConfigsResponse
object, and provides an__iter__
method to iterate through itsapi_configs
field.If there are more pages, the
__iter__
method will make additionalListApiConfigs
requests and continue to iterate through theapi_configs
field on the corresponding responses.All the usual
google.cloud.apigateway_v1.types.ListApiConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.apigateway_v1.types.ListApiConfigsRequest) – The initial request object.
response (google.cloud.apigateway_v1.types.ListApiConfigsResponse) – The initial response object.
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.
- class google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisAsyncPager(method: Callable[[...], Awaitable[google.cloud.apigateway_v1.types.apigateway.ListApisResponse]], request: google.cloud.apigateway_v1.types.apigateway.ListApisRequest, response: google.cloud.apigateway_v1.types.apigateway.ListApisResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_apis
requests.This class thinly wraps an initial
google.cloud.apigateway_v1.types.ListApisResponse
object, and provides an__aiter__
method to iterate through itsapis
field.If there are more pages, the
__aiter__
method will make additionalListApis
requests and continue to iterate through theapis
field on the corresponding responses.All the usual
google.cloud.apigateway_v1.types.ListApisResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.apigateway_v1.types.ListApisRequest) – The initial request object.
response (google.cloud.apigateway_v1.types.ListApisResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListApisPager(method: Callable[[...], google.cloud.apigateway_v1.types.apigateway.ListApisResponse], request: google.cloud.apigateway_v1.types.apigateway.ListApisRequest, response: google.cloud.apigateway_v1.types.apigateway.ListApisResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_apis
requests.This class thinly wraps an initial
google.cloud.apigateway_v1.types.ListApisResponse
object, and provides an__iter__
method to iterate through itsapis
field.If there are more pages, the
__iter__
method will make additionalListApis
requests and continue to iterate through theapis
field on the corresponding responses.All the usual
google.cloud.apigateway_v1.types.ListApisResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.apigateway_v1.types.ListApisRequest) – The initial request object.
response (google.cloud.apigateway_v1.types.ListApisResponse) – The initial response object.
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.
- class google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysAsyncPager(method: Callable[[...], Awaitable[google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse]], request: google.cloud.apigateway_v1.types.apigateway.ListGatewaysRequest, response: google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_gateways
requests.This class thinly wraps an initial
google.cloud.apigateway_v1.types.ListGatewaysResponse
object, and provides an__aiter__
method to iterate through itsgateways
field.If there are more pages, the
__aiter__
method will make additionalListGateways
requests and continue to iterate through thegateways
field on the corresponding responses.All the usual
google.cloud.apigateway_v1.types.ListGatewaysResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.apigateway_v1.types.ListGatewaysRequest) – The initial request object.
response (google.cloud.apigateway_v1.types.ListGatewaysResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.
- class google.cloud.apigateway_v1.services.api_gateway_service.pagers.ListGatewaysPager(method: Callable[[...], google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse], request: google.cloud.apigateway_v1.types.apigateway.ListGatewaysRequest, response: google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_gateways
requests.This class thinly wraps an initial
google.cloud.apigateway_v1.types.ListGatewaysResponse
object, and provides an__iter__
method to iterate through itsgateways
field.If there are more pages, the
__iter__
method will make additionalListGateways
requests and continue to iterate through thegateways
field on the corresponding responses.All the usual
google.cloud.apigateway_v1.types.ListGatewaysResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.apigateway_v1.types.ListGatewaysRequest) – The initial request object.
response (google.cloud.apigateway_v1.types.ListGatewaysResponse) – The initial response object.
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.