Class Api (1.6.1)

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

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

Attributes

NameDescription
name str
Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
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.
managed_service str
Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.
state google.cloud.apigateway_v1.types.Api.State
Output only. State of the API.

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 API states.

Values: STATE_UNSPECIFIED (0): API does not have a state yet. CREATING (1): API is being created. ACTIVE (2): API is active. FAILED (3): API creation failed. DELETING (4): API is being deleted. UPDATING (5): API is being updated.