Class ListBranchesRequest (2.56.0)

public final class ListBranchesRequest extends GeneratedMessageV3 implements ListBranchesRequestOrBuilder

Request for BranchService.ListBranches method.

Protobuf type google.cloud.retail.v2alpha.ListBranchesRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_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 ListBranchesRequest getDefaultInstance()
Returns
Type Description
ListBranchesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ListBranchesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ListBranchesRequest getDefaultInstanceForType()
Returns
Type Description
ListBranchesRequest

getParent()

public String getParent()

Required. The parent catalog resource name.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent catalog resource name.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListBranchesRequest> getParserForType()
Returns
Type Description
Parser<ListBranchesRequest>
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 ListBranchesRequest.Builder newBuilderForType()
Returns
Type Description
ListBranchesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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