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



718
719
720
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 718

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:



710
711
712
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 710

def methods_prop
  @methods_prop
end

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

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

Returns:



700
701
702
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 700

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) 


716
717
718
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 716

def name
  @name
end

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

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

Returns:



705
706
707
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 705

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:



668
669
670
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 668

def source_context
  @source_context
end

#syntax ⇒ String

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

Returns:

  • (String) 


673
674
675
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 673

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) 


695
696
697
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 695

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



723
724
725
726
727
728
729
730
731
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 723

def update!(**args)
  @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)
  @methods_prop = args[:methods_prop] if args.key?(:methods_prop)
  @name = args[:name] if args.key?(:name)
end