Package types (1.0.4)

API documentation for apigateway_v1.types package.

Classes

Api

An API that can be served by one or more Gateways. .. attribute:: name

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

:type: str

ApiConfig

An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

CreateApiConfigRequest

Request message for ApiGatewayService.CreateApiConfig .. attribute:: parent

Required. Parent resource of the API Config, of the form: projects/*/locations/global/apis/*

:type: str

CreateApiRequest

Request message for ApiGatewayService.CreateApi .. attribute:: parent

Required. Parent resource of the API, of the form: projects/*/locations/global

:type: str

CreateGatewayRequest

Request message for ApiGatewayService.CreateGateway .. attribute:: parent

Required. Parent resource of the Gateway, of the form: projects/*/locations/*

:type: str

DeleteApiConfigRequest

Request message for ApiGatewayService.DeleteApiConfig .. attribute:: name

Required. Resource name of the form: projects/*/locations/global/apis/*/configs/*

:type: str

DeleteApiRequest

Request message for ApiGatewayService.DeleteApi .. attribute:: name

Required. Resource name of the form: projects/*/locations/global/apis/*

:type: str

DeleteGatewayRequest

Request message for ApiGatewayService.DeleteGateway .. attribute:: name

Required. Resource name of the form: projects/*/locations/*/gateways/*

:type: str

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.

GetApiConfigRequest

Request message for ApiGatewayService.GetApiConfig .. attribute:: name

Required. Resource name of the form: projects/*/locations/global/apis/*/configs/*

:type: str

GetApiRequest

Request message for ApiGatewayService.GetApi .. attribute:: name

Required. Resource name of the form: projects/*/locations/global/apis/*

:type: str

GetGatewayRequest

Request message for ApiGatewayService.GetGateway .. attribute:: name

Required. Resource name of the form: projects/*/locations/*/gateways/*

:type: str

ListApiConfigsRequest

Request message for ApiGatewayService.ListApiConfigs .. attribute:: parent

Required. Parent resource of the API Config, of the form: projects/*/locations/global/apis/*

:type: str

ListApiConfigsResponse

Response message for ApiGatewayService.ListApiConfigs .. attribute:: api_configs

API Configs.

:type: Sequence[google.cloud.apigateway_v1.types.ApiConfig]

ListApisRequest

Request message for ApiGatewayService.ListApis .. attribute:: parent

Required. Parent resource of the API, of the form: projects/*/locations/global

:type: str

ListApisResponse

Response message for ApiGatewayService.ListApis .. attribute:: apis

APIs.

:type: Sequence[google.cloud.apigateway_v1.types.Api]

ListGatewaysRequest

Request message for ApiGatewayService.ListGateways .. attribute:: parent

Required. Parent resource of the Gateway, of the form: projects/*/locations/*

:type: str

ListGatewaysResponse

Response message for ApiGatewayService.ListGateways .. attribute:: gateways

Gateways.

:type: Sequence[google.cloud.apigateway_v1.types.Gateway]

OperationMetadata

Represents the metadata of the long-running operation. .. attribute:: create_time

Output only. The time the operation was created.

:type: google.protobuf.timestamp_pb2.Timestamp

UpdateApiConfigRequest

Request message for ApiGatewayService.UpdateApiConfig .. attribute:: update_mask

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.

:type: google.protobuf.field_mask_pb2.FieldMask

UpdateApiRequest

Request message for ApiGatewayService.UpdateApi .. attribute:: update_mask

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.

:type: google.protobuf.field_mask_pb2.FieldMask

UpdateGatewayRequest

Request message for ApiGatewayService.UpdateGateway .. attribute:: update_mask

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.

:type: google.protobuf.field_mask_pb2.FieldMask