Package com.google.api

Class SystemParameters

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class SystemParameters extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    RULES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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 final 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()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SystemParameters.Builder
    newBuilder()
     
    static SystemParameters.Builder
    newBuilder(SystemParameters prototype)
     
    SystemParameters.Builder
    newBuilderForType()
     
    protected SystemParameters.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    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.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public SystemParameters getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder