com.google.api.services.servicecontrol.v2.model

Class Api

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.servicecontrol.v2.model.Api

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Api
extends com.google.api.client.json.GenericJson

This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.

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 Control 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

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Api()

Method Summary

Modifier and Type	Method and Description
Api	clone()
String	getOperation() The API operation name.
String	getProtocol() The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
String	getService() The API service name.
String	getVersion() The API version associated with the API operation above, such as "v1" or "v1alpha1".
Api	set(String fieldName, Object value)
Api	setOperation(String operation) The API operation name.
Api	setProtocol(String protocol) The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
Api	setService(String service) The API service name.
Api	setVersion(String version) The API version associated with the API operation above, such as "v1" or "v1alpha1".

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

Constructor Detail

Api

public Api()

Method Detail

getOperation

public String getOperation()

The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the `operationId`, such as "getPet".

Returns:

value or null for none

setOperation

public Api setOperation(String operation)

The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the `operationId`, such as "getPet".

Parameters:

operation - operation or null for none

getProtocol

public String getProtocol()

The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

Returns:

value or null for none

setProtocol

public Api setProtocol(String protocol)

The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

Parameters:

protocol - protocol or null for none

getService

public String getService()

The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

Returns:

value or null for none

setService

public Api setService(String service)

The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

Parameters:

service - service or null for none

getVersion

public String getVersion()

The API version associated with the API operation above, such as "v1" or "v1alpha1".

Returns:

value or null for none

setVersion

public Api setVersion(String version)

The API version associated with the API operation above, such as "v1" or "v1alpha1".

Parameters:

version - version or null for none

set

public Api set(String fieldName,
               Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Api clone()

Overrides:

clone in class com.google.api.client.json.GenericJson