Version(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents a version of the API resource in API hub. This is also referred to as the API version.
Attributes |
|
---|---|
Name | Description |
name |
str
Identifier. The name of the version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}
|
display_name |
str
Required. The display name of the version. |
description |
str
Optional. The description of the version. |
documentation |
google.cloud.apihub_v1.types.Documentation
Optional. The documentation of the version. |
specs |
MutableSequence[str]
Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}
|
api_operations |
MutableSequence[str]
Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
|
definitions |
MutableSequence[str]
Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}
|
deployments |
MutableSequence[str]
Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/{project}/locations/{location}/deployments/{deployment}
|
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the version was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the version was last updated. |
lifecycle |
google.cloud.apihub_v1.types.AttributeValues
Optional. The lifecycle of the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-lifecycle
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.
|
compliance |
google.cloud.apihub_v1.types.AttributeValues
Optional. The compliance associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-compliance
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.
|
accreditation |
google.cloud.apihub_v1.types.AttributeValues
Optional. The accreditations associated with the API version. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-accreditation
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 Version 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.
|
selected_deployment |
str
Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/{project}/locations/{location}/deployments/{deployment}
|
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,
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 |