Class Gateway (1.8.0rc0)

Gateway(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes

NameDescription
name str
Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Created time.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Updated time.
labels MutableMapping[str, str]
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
display_name str
Optional. Display name.
api_config str
Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
state google.cloud.apigateway_v1.types.Gateway.State
Output only. The current state of the Gateway.
default_hostname str
Output only. The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

All the possible Gateway states.

Values: STATE_UNSPECIFIED (0): Gateway does not have a state yet. CREATING (1): Gateway is being created. ACTIVE (2): Gateway is running and ready for requests. FAILED (3): Gateway creation failed. DELETING (4): Gateway is being deleted. UPDATING (5): Gateway is being updated.