Class SystemParameter

public final class SystemParameter extends GeneratedMessageV3 implements SystemParameterOrBuilder

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

Protobuf type google.api.SystemParameter

Fields

HTTP_HEADER_FIELD_NUMBER

public static final int HTTP_HEADER_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

URL_QUERY_PARAMETER_FIELD_NUMBER

public static final int URL_QUERY_PARAMETER_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static SystemParameter getDefaultInstance()
Returns
TypeDescription
SystemParameter

getDefaultInstanceForType()

public SystemParameter getDefaultInstanceForType()
Returns
TypeDescription
SystemParameter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getHttpHeader()

public String getHttpHeader()

Define the HTTP header name to use for the parameter. It is case insensitive.

string http_header = 2;

Returns
TypeDescription
String

The httpHeader.

getHttpHeaderBytes()

public ByteString getHttpHeaderBytes()

Define the HTTP header name to use for the parameter. It is case insensitive.

string http_header = 2;

Returns
TypeDescription
ByteString

The bytes for httpHeader.

getName()

public String getName()

Define the name of the parameter, such as "api_key" . It is case sensitive.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Define the name of the parameter, such as "api_key" . It is case sensitive.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<SystemParameter> getParserForType()
Returns
TypeDescription
Parser<SystemParameter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUrlQueryParameter()

public String getUrlQueryParameter()

Define the URL query parameter name to use for the parameter. It is case sensitive.

string url_query_parameter = 3;

Returns
TypeDescription
String

The urlQueryParameter.

getUrlQueryParameterBytes()

public ByteString getUrlQueryParameterBytes()

Define the URL query parameter name to use for the parameter. It is case sensitive.

string url_query_parameter = 3;

Returns
TypeDescription
ByteString

The bytes for urlQueryParameter.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static SystemParameter.Builder newBuilder()
Returns
TypeDescription
SystemParameter.Builder

newBuilder(SystemParameter prototype)

public static SystemParameter.Builder newBuilder(SystemParameter prototype)
Parameter
NameDescription
prototypeSystemParameter
Returns
TypeDescription
SystemParameter.Builder

newBuilderForType()

public SystemParameter.Builder newBuilderForType()
Returns
TypeDescription
SystemParameter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SystemParameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SystemParameter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static SystemParameter parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SystemParameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SystemParameter parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SystemParameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SystemParameter parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SystemParameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SystemParameter parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SystemParameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SystemParameter parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SystemParameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SystemParameter parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SystemParameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SystemParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SystemParameter> parser()
Returns
TypeDescription
Parser<SystemParameter>

toBuilder()

public SystemParameter.Builder toBuilder()
Returns
TypeDescription
SystemParameter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException