Class: Google::Apis::ServiceuserV1::Api

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceuser_v1/classes.rb,
generated/google/apis/serviceuser_v1/representations.rb,
generated/google/apis/serviceuser_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



1072
1073
1074
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1072

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

Instance Attribute Details

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

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

Returns:



1064
1065
1066
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1064

def methods_prop
  @methods_prop
end

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

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

Returns:



1054
1055
1056
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1054

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) 


1070
1071
1072
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1070

def name
  @name
end

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

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

Returns:



1059
1060
1061
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1059

def options
  @options
end

#source_context ⇒ Google::Apis::ServiceuserV1::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:



1027
1028
1029
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1027

def source_context
  @source_context
end

#syntax ⇒ String

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

Returns:

  • (String) 


1021
1022
1023
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1021

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) 


1049
1050
1051
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1049

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1077
1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1077

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