public final class SystemParameter extends GeneratedMessageV3 implements SystemParameterOrBuilderDefine 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SystemParameterImplements
SystemParameterOrBuilderStatic Fields
HTTP_HEADER_FIELD_NUMBER
public static final int HTTP_HEADER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
URL_QUERY_PARAMETER_FIELD_NUMBER
public static final int URL_QUERY_PARAMETER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static SystemParameter getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static SystemParameter.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
SystemParameter.Builder | |
newBuilder(SystemParameter prototype)
public static SystemParameter.Builder newBuilder(SystemParameter prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | SystemParameter |
| Returns | |
|---|---|
| Type | Description |
SystemParameter.Builder | |
parseDelimitedFrom(InputStream input)
public static SystemParameter parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SystemParameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static SystemParameter parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SystemParameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static SystemParameter parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SystemParameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static SystemParameter parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SystemParameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static SystemParameter parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SystemParameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static SystemParameter parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SystemParameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<SystemParameter> parser()| Returns | |
|---|---|
| Type | Description |
Parser<SystemParameter> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDefaultInstanceForType()
public SystemParameter getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SystemParameter | |
getHttpHeader()
public String getHttpHeader()Define the HTTP header name to use for the parameter. It is case insensitive.
string http_header = 2;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getParserForType()
public Parser<SystemParameter> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<SystemParameter> | |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString | The bytes for urlQueryParameter. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public SystemParameter.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
SystemParameter.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SystemParameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
SystemParameter.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public SystemParameter.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
SystemParameter.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |