Class: Google::Apis::ServicenetworkingV1::Api

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

Overview

Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the " service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

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.


362
363
364
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 362

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

Instance Attribute Details

#methods_propArray<Google::Apis::ServicenetworkingV1::MethodProp>

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


316
317
318
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 316

def methods_prop
  @methods_prop
end

#mixinsArray<Google::Apis::ServicenetworkingV1::Mixin>

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


321
322
323
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 321

def mixins
  @mixins
end

#nameString

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

Returns:

  • (String)

327
328
329
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 327

def name
  @name
end

#optionsArray<Google::Apis::ServicenetworkingV1::Option>

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


332
333
334
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 332

def options
  @options
end

#source_contextGoogle::Apis::ServicenetworkingV1::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


338
339
340
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 338

def source_context
  @source_context
end

#syntaxString

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

Returns:

  • (String)

343
344
345
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 343

def syntax
  @syntax
end

#versionString

A version string for this interface. 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 interface, which must end in v, 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, non-GA interfaces. Corresponds to the JSON property version

Returns:

  • (String)

360
361
362
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 360

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


367
368
369
370
371
372
373
374
375
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 367

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