Class: Google::Apis::ServicemanagementV1::Api

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/servicemanagement_v1/classes.rb,
generated/google/apis/servicemanagement_v1/representations.rb,
generated/google/apis/servicemanagement_v1/representations.rb

Overview

Api is a light-weight descriptor for a protocol buffer service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Api

Returns a new instance of Api



2336
2337
2338
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2336

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#methods_prop ⇒ Array<Google::Apis::ServicemanagementV1::MethodProp>

The methods of this api, in unspecified order. Corresponds to the JSON property methods

Returns:



2285
2286
2287
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2285

def methods_prop
  @methods_prop
end

#mixins ⇒ Array<Google::Apis::ServicemanagementV1::Mixin>

Included APIs. See Mixin. Corresponds to the JSON property mixins

Returns:



2329
2330
2331
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2329

def mixins
  @mixins
end

#name ⇒ String

The fully qualified name of this api, including package name followed by the api's simple name. Corresponds to the JSON property name

Returns:

  • (String) 


2291
2292
2293
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2291

def name
  @name
end

#options ⇒ Array<Google::Apis::ServicemanagementV1::Option>

Any metadata attached to the API. Corresponds to the JSON property options

Returns:



2334
2335
2336
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2334

def options
  @options
end

#source_context ⇒ Google::Apis::ServicemanagementV1::SourceContext

SourceContext represents information about the source of a protobuf element, like the file in which it is defined. Corresponds to the JSON property sourceContext

Returns:



2297
2298
2299
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2297

def source_context
  @source_context
end

#syntax ⇒ String

The source syntax of the service. Corresponds to the JSON property syntax

Returns:

  • (String) 


2302
2303
2304
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2302

def syntax
  @syntax
end

#version ⇒ String

A version string for this api. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the API, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, none-GA apis. Corresponds to the JSON property version

Returns:

  • (String) 


2324
2325
2326
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2324

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2341
2342
2343
2344
2345
2346
2347
2348
2349
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2341

def update!(**args)
  @methods_prop = args[:methods_prop] if args.key?(:methods_prop)
  @name = args[:name] if args.key?(:name)
  @source_context = args[:source_context] if args.key?(:source_context)
  @syntax = args[:syntax] if args.key?(:syntax)
  @version = args[:version] if args.key?(:version)
  @mixins = args[:mixins] if args.key?(:mixins)
  @options = args[:options] if args.key?(:options)
end