Class GetBranchRequest (2.57.0) 

public final class GetBranchRequest extends GeneratedMessageV3 implements GetBranchRequestOrBuilder

Request for BranchService.GetBranch method.

Protobuf type google.cloud.retail.v2alpha.GetBranchRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GetBranchRequest

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 GetBranchRequest getDefaultInstance()
Returns
Type Description
GetBranchRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GetBranchRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetBranchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GetBranchRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GetBranchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GetBranchRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GetBranchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GetBranchRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GetBranchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetBranchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GetBranchRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GetBranchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GetBranchRequest> parser()
Returns
Type Description
Parser<GetBranchRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public GetBranchRequest getDefaultInstanceForType()
Returns
Type Description
GetBranchRequest

getName()

public String getName()

Required. The name of the branch to retrieve. Format: projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id.

"default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the branch to retrieve. Format: projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id.

"default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<GetBranchRequest> getParserForType()
Returns
Type Description
Parser<GetBranchRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getView()

public BranchView getView()

The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

.google.cloud.retail.v2alpha.BranchView view = 2;

Returns
Type Description
BranchView

The view.

getViewValue()

public int getViewValue()

The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

.google.cloud.retail.v2alpha.BranchView view = 2;

Returns
Type Description
int

The enum numeric value on the wire for view.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GetBranchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GetBranchRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException