target.apidocs.com.google.api.services.serviceconsumermanagement.v1.model.Mixin.html Maven / Gradle / Ivy
Mixin (Service Consumer Management API v1-rev20210525-1.31.0)
com.google.api.services.serviceconsumermanagement.v1.model
Class Mixin
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.serviceconsumermanagement.v1.model.Mixin
-
public final class Mixin
extends GenericJson
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 inheriting
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"; } ... }
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Service Consumer Management API. For a detailed
explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Mixin()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Mixinclone()
StringgetName()
The fully qualified name of the interface which is included.
StringgetRoot()
If non-empty specifies a path under which inherited HTTP paths are rooted.
Mixinset(String fieldName,
Object value)
MixinsetName(String name)
The fully qualified name of the interface which is included.
MixinsetRoot(String root)
If non-empty specifies a path under which inherited HTTP paths are rooted.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getName
public String getName()
The fully qualified name of the interface which is included.
- Returns:
- value or
null for none
-
setName
public Mixin setName(String name)
The fully qualified name of the interface which is included.
- Parameters:
name - name or null for none
-
getRoot
public String getRoot()
If non-empty specifies a path under which inherited HTTP paths are rooted.
- Returns:
- value or
null for none
-
setRoot
public Mixin setRoot(String root)
If non-empty specifies a path under which inherited HTTP paths are rooted.
- Parameters:
root - root or null for none
-
set
public Mixin set(String fieldName,
Object value)
- Overrides:
set in class GenericJson
-
clone
public Mixin clone()
- Overrides:
clone in class GenericJson
Copyright © 2011–2021 Google. All rights reserved.