Class Definition (0.2.1)

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

Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only schema object is supported.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
schema google.cloud.apihub_v1.types.Schema
Output only. The value of a schema definition. This field is a member of oneof_ value.
name str
Identifier. The name of the definition. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
spec str
Output only. The name of the spec from where the definition was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
type_ google.cloud.apihub_v1.types.Definition.Type
Output only. The type of the definition.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the definition was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the definition was last updated.
attributes MutableMapping[str, google.cloud.apihub_v1.types.AttributeValues]
Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

Classes

AttributesEntry

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

The abstract base class for a message.

Parameters
Name Description
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.

Type

Type(value)

Enumeration of definition types.