Class Api (0.2.2)

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

An API resource in the API Hub.

Attributes
Name	Description
`name`	`str` Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
`display_name`	`str` Required. The display name of the API resource.
`description`	`str` Optional. The description of the API resource.
`documentation`	`google.cloud.apihub_v1.types.Documentation` Optional. The documentation for the API resource.
`owner`	`google.cloud.apihub_v1.types.Owner` Optional. Owner details for the API resource.
`versions`	`MutableSequence[str]` Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The time at which the API resource was created.
`update_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The time at which the API resource was last updated.
`target_user`	`google.cloud.apihub_v1.types.AttributeValues` Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
`team`	`google.cloud.apihub_v1.types.AttributeValues` Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
`business_unit`	`google.cloud.apihub_v1.types.AttributeValues` Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
`maturity_level`	`google.cloud.apihub_v1.types.AttributeValues` Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
`attributes`	`MutableMapping[str, google.cloud.apihub_v1.types.AttributeValues]` Optional. The list of user defined attributes associated with the API 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.
`api_style`	`google.cloud.apihub_v1.types.AttributeValues` Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
`selected_version`	`str` Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`

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.