Class: Google::Apis::ApigeeregistryV1::Api
- Inherits:
-
Object
- Object
- Google::Apis::ApigeeregistryV1::Api
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/apigeeregistry_v1/classes.rb,
lib/google/apis/apigeeregistry_v1/representations.rb,
lib/google/apis/apigeeregistry_v1/representations.rb
Overview
A top-level description of an API. Produced by producers and are commitments to provide services.
Instance Attribute Summary collapse
-
#annotations ⇒ Hash<String,String>
Annotations attach non-identifying metadata to resources.
-
#availability ⇒ String
A user-definable description of the availability of this service.
-
#create_time ⇒ String
Output only.
-
#description ⇒ String
A detailed description.
-
#display_name ⇒ String
Human-meaningful name.
-
#labels ⇒ Hash<String,String>
Labels attach identifying metadata to resources.
-
#name ⇒ String
Resource name.
-
#recommended_deployment ⇒ String
The recommended deployment of the API.
-
#recommended_version ⇒ String
The recommended version of the API.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Api
constructor
A new instance of Api.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Api
Returns a new instance of Api.
94 95 96 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 94 def initialize(**args) update!(**args) end |
Instance Attribute Details
#annotations ⇒ Hash<String,String>
Annotations attach non-identifying metadata to resources. Annotation keys and
values are less restricted than those of labels, but should be generally used
for small values of broad interest. Larger, topic- specific metadata should be
stored in Artifacts.
Corresponds to the JSON property annotations
36 37 38 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 36 def annotations @annotations end |
#availability ⇒ String
A user-definable description of the availability of this service. Format: free-
form, but we expect single words that describe availability, e.g., "NONE", "
TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
Corresponds to the JSON property availability
43 44 45 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 43 def availability @availability end |
#create_time ⇒ String
Output only. Creation timestamp.
Corresponds to the JSON property createTime
48 49 50 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 48 def create_time @create_time end |
#description ⇒ String
A detailed description.
Corresponds to the JSON property description
53 54 55 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 53 def description @description end |
#display_name ⇒ String
Human-meaningful name.
Corresponds to the JSON property displayName
58 59 60 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 58 def display_name @display_name end |
#labels ⇒ Hash<String,String>
Labels attach identifying metadata to resources. Identifying metadata can be
used to filter list operations. Label keys and values can be no longer than 64
characters (Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores, and dashes. International characters are allowed. No
more than 64 user labels can be associated with one resource (System labels
are excluded). See https://goo.gl/xmQnxf for more information and examples of
labels. System reserved label keys are prefixed with apigeeregistry.
googleapis.com/
and cannot be changed.
Corresponds to the JSON property labels
70 71 72 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 70 def labels @labels end |
#name ⇒ String
Resource name.
Corresponds to the JSON property name
75 76 77 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 75 def name @name end |
#recommended_deployment ⇒ String
The recommended deployment of the API. Format: projects/
project/locations/
location/apis/
api/deployments/
deployment`
Corresponds to the JSON property
recommendedDeployment`
81 82 83 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 81 def recommended_deployment @recommended_deployment end |
#recommended_version ⇒ String
The recommended version of the API. Format: projects/
project/locations/
location/apis/
api/versions/
version`
Corresponds to the JSON property
recommendedVersion`
87 88 89 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 87 def recommended_version @recommended_version end |
#update_time ⇒ String
Output only. Last update timestamp.
Corresponds to the JSON property updateTime
92 93 94 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 92 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 99 def update!(**args) @annotations = args[:annotations] if args.key?(:annotations) @availability = args[:availability] if args.key?(:availability) @create_time = args[:create_time] if args.key?(:create_time) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @recommended_deployment = args[:recommended_deployment] if args.key?(:recommended_deployment) @recommended_version = args[:recommended_version] if args.key?(:recommended_version) @update_time = args[:update_time] if args.key?(:update_time) end |