Package com.google.api

Class SystemParameters

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.SystemParameters

All Implemented Interfaces:

SystemParametersOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class SystemParameters
extends com.google.protobuf.GeneratedMessageV3
implements SystemParametersOrBuilder

 ### System parameter configuration
 A system parameter is a special kind of parameter defined by the API
 system, not by an individual API. It is typically mapped to an HTTP header
 and/or a URL query parameter. This configuration specifies which methods
 change the names of the system parameters.
 

Protobuf type google.api.SystemParameters

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemParameters.Builder	### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	RULES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static SystemParameters	getDefaultInstance()
SystemParameters	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<SystemParameters>	getParserForType()
SystemParameterRule	getRules(int index)	Define system parameters.
int	getRulesCount()	Define system parameters.
List<SystemParameterRule>	getRulesList()	Define system parameters.
SystemParameterRuleOrBuilder	getRulesOrBuilder(int index)	Define system parameters.
List<? extends SystemParameterRuleOrBuilder>	getRulesOrBuilderList()	Define system parameters.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SystemParameters.Builder	newBuilder()
static SystemParameters.Builder	newBuilder(SystemParameters prototype)
SystemParameters.Builder	newBuilderForType()
protected SystemParameters.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SystemParameters	parseDelimitedFrom(InputStream input)
static SystemParameters	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SystemParameters	parseFrom(byte[] data)
static SystemParameters	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SystemParameters	parseFrom(com.google.protobuf.ByteString data)
static SystemParameters	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SystemParameters	parseFrom(com.google.protobuf.CodedInputStream input)
static SystemParameters	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SystemParameters	parseFrom(InputStream input)
static SystemParameters	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SystemParameters	parseFrom(ByteBuffer data)
static SystemParameters	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SystemParameters>	parser()
SystemParameters.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRulesList

public List<SystemParameterRule> getRulesList()

 Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
 

repeated .google.api.SystemParameterRule rules = 1;

Specified by:

getRulesList in interface SystemParametersOrBuilder

getRulesOrBuilderList

public List<? extends SystemParameterRuleOrBuilder> getRulesOrBuilderList()

 Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
 

repeated .google.api.SystemParameterRule rules = 1;

Specified by:

getRulesOrBuilderList in interface SystemParametersOrBuilder

getRulesCount

public int getRulesCount()

 Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
 

repeated .google.api.SystemParameterRule rules = 1;

Specified by:

getRulesCount in interface SystemParametersOrBuilder

getRules

public SystemParameterRule getRules(int index)

 Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
 

repeated .google.api.SystemParameterRule rules = 1;

Specified by:

getRules in interface SystemParametersOrBuilder

getRulesOrBuilder

public SystemParameterRuleOrBuilder getRulesOrBuilder(int index)

 Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
 

repeated .google.api.SystemParameterRule rules = 1;

Specified by:

getRulesOrBuilder in interface SystemParametersOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SystemParameters parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SystemParameters parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SystemParameters parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SystemParameters parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SystemParameters parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SystemParameters parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SystemParameters parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static SystemParameters parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static SystemParameters parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static SystemParameters parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static SystemParameters parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static SystemParameters parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public SystemParameters.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SystemParameters.Builder newBuilder()

newBuilder

public static SystemParameters.Builder newBuilder(SystemParameters prototype)

toBuilder

public SystemParameters.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SystemParameters.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SystemParameters getDefaultInstance()

parser

public static com.google.protobuf.Parser<SystemParameters> parser()

getParserForType

public com.google.protobuf.Parser<SystemParameters> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SystemParameters getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder