Class GetDocumentRequest (0.3.0)

public final class GetDocumentRequest extends GeneratedMessage implements GetDocumentRequestOrBuilder

Request message for DeveloperKnowledge.GetDocument.

Protobuf type google.developers.knowledge.v1.GetDocumentRequest

Inheritance

Object > com.google.protobuf.AbstractMessageLite > com.google.protobuf.AbstractMessage > com.google.protobuf.GeneratedMessage > GetDocumentRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetDocumentRequest getDefaultInstance()
Returns
Type Description
GetDocumentRequest

getDescriptor()

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

newBuilder()

public static GetDocumentRequest.Builder newBuilder()
Returns
Type Description
GetDocumentRequest.Builder

newBuilder(GetDocumentRequest prototype)

public static GetDocumentRequest.Builder newBuilder(GetDocumentRequest prototype)
Parameter
Name Description
prototype GetDocumentRequest
Returns
Type Description
GetDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static GetDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GetDocumentRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GetDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteString data)

public static GetDocumentRequest parseFrom(ByteString data)
Parameter
Name Description
data com.google.protobuf.ByteString
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GetDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data com.google.protobuf.ByteString
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GetDocumentRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input com.google.protobuf.CodedInputStream
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GetDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input com.google.protobuf.CodedInputStream
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GetDocumentRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GetDocumentRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GetDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry com.google.protobuf.ExtensionRegistryLite
Returns
Type Description
GetDocumentRequest
Exceptions
Type Description
com.google.protobuf.InvalidProtocolBufferException

parser()

public static Parser<GetDocumentRequest> parser()
Returns
Type Description
com.google.protobuf.Parser<GetDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides
com.google.protobuf.AbstractMessage.equals(java.lang.Object)

getDefaultInstanceForType()

public GetDocumentRequest getDefaultInstanceForType()
Returns
Type Description
GetDocumentRequest

getName()

public String getName()

Required. Specifies the name of the document to retrieve. Format: documents/{uri_without_scheme} Example: documents/docs.cloud.google.com/storage/docs/creating-buckets

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Specifies the name of the document to retrieve. Format: documents/{uri_without_scheme} Example: documents/docs.cloud.google.com/storage/docs/creating-buckets

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
com.google.protobuf.ByteString

The bytes for name.

getParserForType()

public Parser<GetDocumentRequest> getParserForType()
Returns
Type Description
com.google.protobuf.Parser<GetDocumentRequest>
Overrides
com.google.protobuf.GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides
com.google.protobuf.GeneratedMessage.getSerializedSize()

getView()

public DocumentView getView()

Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.GetDocument defaults to DOCUMENT_VIEW_CONTENT.

.google.developers.knowledge.v1.DocumentView view = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DocumentView

The view.

getViewValue()

public int getViewValue()

Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.GetDocument defaults to DOCUMENT_VIEW_CONTENT.

.google.developers.knowledge.v1.DocumentView view = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for view.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides
com.google.protobuf.AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
com.google.protobuf.GeneratedMessage.FieldAccessorTable
Overrides
com.google.protobuf.GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides
com.google.protobuf.GeneratedMessage.isInitialized()

newBuilderForType()

public GetDocumentRequest.Builder newBuilderForType()
Returns
Type Description
GetDocumentRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected GetDocumentRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent com.google.protobuf.AbstractMessage.BuilderParent
Returns
Type Description
GetDocumentRequest.Builder
Overrides
com.google.protobuf.AbstractMessage.newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent)

toBuilder()

public GetDocumentRequest.Builder toBuilder()
Returns
Type Description
GetDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output com.google.protobuf.CodedOutputStream
Overrides
com.google.protobuf.GeneratedMessage.writeTo(com.google.protobuf.CodedOutputStream)
Exceptions
Type Description
IOException