HeaderParameter.Builder (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<HeaderParameter.Builder>
    - - com.grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderParameterOrBuilder, java.lang.Cloneable

Enclosing class:

HeaderParameter
```
public static final class HeaderParameter.Builder
extends com.google.protobuf.GeneratedMessage.Builder<HeaderParameter.Builder>
implements HeaderParameterOrBuilder
```
```
 `HeaderParameter` a HTTP header parameter.
 See: https://swagger.io/specification/v2/#parameter-object
 
```
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HeaderParameter`	`build()`
`HeaderParameter`	`buildPartial()`
`HeaderParameter.Builder`	`clear()`
`HeaderParameter.Builder`	`clearDescription()` `Description` is a short description of the header.
`HeaderParameter.Builder`	`clearFormat()` `Format` The extending format for the previously mentioned type.
`HeaderParameter.Builder`	`clearName()` `Name` is the header name.
`HeaderParameter.Builder`	`clearRequired()` `Required` indicates if the header is optional
`HeaderParameter.Builder`	`clearType()` `Type` is the type of the object.
`HeaderParameter`	`getDefaultInstanceForType()`
`java.lang.String`	`getDescription()` `Description` is a short description of the header.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` `Description` is a short description of the header.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getFormat()` `Format` The extending format for the previously mentioned type.
`com.google.protobuf.ByteString`	`getFormatBytes()` `Format` The extending format for the previously mentioned type.
`java.lang.String`	`getName()` `Name` is the header name.
`com.google.protobuf.ByteString`	`getNameBytes()` `Name` is the header name.
`boolean`	`getRequired()` `Required` indicates if the header is optional
`HeaderParameter.Type`	`getType()` `Type` is the type of the object.
`int`	`getTypeValue()` `Type` is the type of the object.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`HeaderParameter.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`HeaderParameter.Builder`	`mergeFrom(HeaderParameter other)`
`HeaderParameter.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`HeaderParameter.Builder`	`setDescription(java.lang.String value)` `Description` is a short description of the header.
`HeaderParameter.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` `Description` is a short description of the header.
`HeaderParameter.Builder`	`setFormat(java.lang.String value)` `Format` The extending format for the previously mentioned type.
`HeaderParameter.Builder`	`setFormatBytes(com.google.protobuf.ByteString value)` `Format` The extending format for the previously mentioned type.
`HeaderParameter.Builder`	`setName(java.lang.String value)` `Name` is the header name.
`HeaderParameter.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` `Name` is the header name.
`HeaderParameter.Builder`	`setRequired(boolean value)` `Required` indicates if the header is optional
`HeaderParameter.Builder`	`setType(HeaderParameter.Type value)` `Type` is the type of the object.
`HeaderParameter.Builder`	`setTypeValue(int value)` `Type` is the type of the object.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - 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.Builder<HeaderParameter.Builder>
  - clear
```
public HeaderParameter.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessage.Builder<HeaderParameter.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<HeaderParameter.Builder>
  - getDefaultInstanceForType
```
public HeaderParameter getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public HeaderParameter build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public HeaderParameter buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public HeaderParameter.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HeaderParameter.Builder>
  - mergeFrom
```
public HeaderParameter.Builder mergeFrom(HeaderParameter other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<HeaderParameter.Builder>
  - mergeFrom
```
public HeaderParameter.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HeaderParameter.Builder>
    
    Throws:
    
    java.io.IOException
  - getName
```
public java.lang.String getName()
```
```
 `Name` is the header name.
 
```
    string name = 1 [json_name = "name"];
    Specified by:
    
    getName in interface HeaderParameterOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 `Name` is the header name.
 
```
    string name = 1 [json_name = "name"];
    Specified by:
    
    getNameBytes in interface HeaderParameterOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
public HeaderParameter.Builder setName(java.lang.String value)
```
```
 `Name` is the header name.
 
```
    string name = 1 [json_name = "name"];
    Parameters:
    
    value - The name to set.
    
    Returns:
    
    This builder for chaining.
  - clearName
```
public HeaderParameter.Builder clearName()
```
```
 `Name` is the header name.
 
```
    string name = 1 [json_name = "name"];
    Returns:
    
    This builder for chaining.
  - setNameBytes
```
public HeaderParameter.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 `Name` is the header name.
 
```
    string name = 1 [json_name = "name"];
    Parameters:
    
    value - The bytes for name to set.
    
    Returns:
    
    This builder for chaining.
  - getDescription
```
public java.lang.String getDescription()
```
```
 `Description` is a short description of the header.
 
```
    string description = 2 [json_name = "description"];
    Specified by:
    
    getDescription in interface HeaderParameterOrBuilder
    
    Returns:
    
    The description.
  - getDescriptionBytes
```
public com.google.protobuf.ByteString getDescriptionBytes()
```
```
 `Description` is a short description of the header.
 
```
    string description = 2 [json_name = "description"];
    Specified by:
    
    getDescriptionBytes in interface HeaderParameterOrBuilder
    
    Returns:
    
    The bytes for description.
  - setDescription
```
public HeaderParameter.Builder setDescription(java.lang.String value)
```
```
 `Description` is a short description of the header.
 
```
    string description = 2 [json_name = "description"];
    Parameters:
    
    value - The description to set.
    
    Returns:
    
    This builder for chaining.
  - clearDescription
```
public HeaderParameter.Builder clearDescription()
```
```
 `Description` is a short description of the header.
 
```
    string description = 2 [json_name = "description"];
    Returns:
    
    This builder for chaining.
  - setDescriptionBytes
```
public HeaderParameter.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
```
```
 `Description` is a short description of the header.
 
```
    string description = 2 [json_name = "description"];
    Parameters:
    
    value - The bytes for description to set.
    
    Returns:
    
    This builder for chaining.
  - getTypeValue
```
public int getTypeValue()
```
```
 `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
 See: https://swagger.io/specification/v2/#parameterType.
 
```
    .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3 [json_name = "type"];
    Specified by:
    
    getTypeValue in interface HeaderParameterOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for type.
  - setTypeValue
```
public HeaderParameter.Builder setTypeValue(int value)
```
```
 `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
 See: https://swagger.io/specification/v2/#parameterType.
 
```
    .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3 [json_name = "type"];
    Parameters:
    
    value - The enum numeric value on the wire for type to set.
    
    Returns:
    
    This builder for chaining.
  - getType
```
public HeaderParameter.Type getType()
```
```
 `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
 See: https://swagger.io/specification/v2/#parameterType.
 
```
    .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3 [json_name = "type"];
    Specified by:
    
    getType in interface HeaderParameterOrBuilder
    
    Returns:
    
    The type.
  - setType
```
public HeaderParameter.Builder setType(HeaderParameter.Type value)
```
```
 `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
 See: https://swagger.io/specification/v2/#parameterType.
 
```
    .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3 [json_name = "type"];
    Parameters:
    
    value - The type to set.
    
    Returns:
    
    This builder for chaining.
  - clearType
```
public HeaderParameter.Builder clearType()
```
```
 `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
 See: https://swagger.io/specification/v2/#parameterType.
 
```
    .grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3 [json_name = "type"];
    Returns:
    
    This builder for chaining.
  - getFormat
```
public java.lang.String getFormat()
```
```
 `Format` The extending format for the previously mentioned type.
 
```
    string format = 4 [json_name = "format"];
    Specified by:
    
    getFormat in interface HeaderParameterOrBuilder
    
    Returns:
    
    The format.
  - getFormatBytes
```
public com.google.protobuf.ByteString getFormatBytes()
```
```
 `Format` The extending format for the previously mentioned type.
 
```
    string format = 4 [json_name = "format"];
    Specified by:
    
    getFormatBytes in interface HeaderParameterOrBuilder
    
    Returns:
    
    The bytes for format.
  - setFormat
```
public HeaderParameter.Builder setFormat(java.lang.String value)
```
```
 `Format` The extending format for the previously mentioned type.
 
```
    string format = 4 [json_name = "format"];
    Parameters:
    
    value - The format to set.
    
    Returns:
    
    This builder for chaining.
  - clearFormat
```
public HeaderParameter.Builder clearFormat()
```
```
 `Format` The extending format for the previously mentioned type.
 
```
    string format = 4 [json_name = "format"];
    Returns:
    
    This builder for chaining.
  - setFormatBytes
```
public HeaderParameter.Builder setFormatBytes(com.google.protobuf.ByteString value)
```
```
 `Format` The extending format for the previously mentioned type.
 
```
    string format = 4 [json_name = "format"];
    Parameters:
    
    value - The bytes for format to set.
    
    Returns:
    
    This builder for chaining.
  - getRequired
```
public boolean getRequired()
```
```
 `Required` indicates if the header is optional
 
```
    bool required = 5 [json_name = "required"];
    Specified by:
    
    getRequired in interface HeaderParameterOrBuilder
    
    Returns:
    
    The required.
  - setRequired
```
public HeaderParameter.Builder setRequired(boolean value)
```
```
 `Required` indicates if the header is optional
 
```
    bool required = 5 [json_name = "required"];
    Parameters:
    
    value - The required to set.
    
    Returns:
    
    This builder for chaining.
  - clearRequired
```
public HeaderParameter.Builder clearRequired()
```
```
 `Required` indicates if the header is optional
 
```
    bool required = 5 [json_name = "required"];
    Returns:
    
    This builder for chaining.

Class HeaderParameter.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getDescription

getDescriptionBytes

setDescription

clearDescription

setDescriptionBytes

getTypeValue

setTypeValue

getType

setType

clearType

getFormat

getFormatBytes

setFormat

clearFormat

setFormatBytes

getRequired

setRequired

clearRequired