Resource: 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.
JSON representation | |
---|---|
{
"name": string,
"createTime": string,
"updateTime": string,
"labels": {
string: string,
...
},
"displayName": string,
"apiConfig": string,
"state": enum ( |
Fields | |
---|---|
name |
Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} |
createTime |
Output only. Created time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Updated time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources An object containing a list of |
displayName |
Optional. Display name. |
apiConfig |
Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig} |
state |
Output only. The current state of the Gateway. |
defaultHostname |
Output only. The default API Gateway host name of the form |
State
All the possible Gateway states.
Enums | |
---|---|
STATE_UNSPECIFIED |
Gateway does not have a state yet. |
CREATING |
Gateway is being created. |
ACTIVE |
Gateway is running and ready for requests. |
FAILED |
Gateway creation failed. |
DELETING |
Gateway is being deleted. |
UPDATING |
Gateway is being updated. |
Methods |
|
---|---|
|
Creates a new Gateway in a given project and location. |
|
Deletes a single Gateway. |
|
Gets details of a single Gateway. |
|
Gets the access control policy for a resource. |
|
Lists Gateways in a given project and location. |
|
Updates the parameters of a single Gateway. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |