Class: Google::Apis::ServiceusageV1::Mixin

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

Overview

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows:

  • If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.
  • Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited.
  • If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) option (google.api.http).get = "/v1/resource=**:getAcl"; package google.storage.v2; service Storage // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) option (google.api.http).get = "/v2/resource=**"; Example of a mixin configuration: apis:
  • name: google.storage.v2.Storage mixins:
  • name: google.acl.v1.AccessControl The mixin construct implies that all methods in AccessControl are also declared with same name and request/response types in Storage. A documentation generator or annotation processor will see the effective Storage.GetAcl method after inherting documentation and annotations as follows: service Storage // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) option (google.api.http).get = "/v2/resource=**:getAcl"; ... Note how the version in the path pattern changed from v1 to v2. If the root field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis:
  • name: google.storage.v2.Storage mixins:
  • name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) option (google.api.http).get = "/v2/acls/resource=**:getAcl"; ...

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) ⇒ Mixin

Returns a new instance of Mixin.



3225
3226
3227
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3225

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

Instance Attribute Details

#nameString

The fully qualified name of the interface which is included. Corresponds to the JSON property name

Returns:

  • (String)


3217
3218
3219
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3217

def name
  @name
end

#rootString

If non-empty specifies a path under which inherited HTTP paths are rooted. Corresponds to the JSON property root

Returns:

  • (String)


3223
3224
3225
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3223

def root
  @root
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3230
3231
3232
3233
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3230

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @root = args[:root] if args.key?(:root)
end