Class GetBranchRequest.Builder (2.74.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version latestkeyboard_arrow_down
public static final class GetBranchRequest . Builder extends GeneratedMessageV3 . Builder<GetBranchRequest . Builder > implements GetBranchRequestOrBuilder
Request for
BranchService.GetBranch
method.
Protobuf type google.cloud.retail.v2alpha.GetBranchRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GetBranchRequest . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public GetBranchRequest build ()
buildPartial()
public GetBranchRequest buildPartial ()
clear()
public GetBranchRequest . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public GetBranchRequest . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearName()
public GetBranchRequest . Builder clearName ()
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) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public GetBranchRequest . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearView()
public GetBranchRequest . Builder clearView ()
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;
clone()
public GetBranchRequest . Builder clone ()
Overrides
getDefaultInstanceForType()
public GetBranchRequest getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
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.
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;
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.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(GetBranchRequest other)
public GetBranchRequest . Builder mergeFrom ( GetBranchRequest other )
public GetBranchRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public GetBranchRequest . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GetBranchRequest . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public GetBranchRequest . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setName(String value)
public GetBranchRequest . Builder setName ( String value )
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) = { ... }
Parameter
Name Description
valueString The name to set.
setNameBytes(ByteString value)
public GetBranchRequest . Builder setNameBytes ( ByteString value )
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) = { ... }
Parameter
Name Description
valueByteString The bytes for name to set.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GetBranchRequest . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final GetBranchRequest . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setView(BranchView value)
public GetBranchRequest . Builder setView ( BranchView value )
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;
Parameter
Name Description
valueBranchView The view to set.
setViewValue(int value)
public GetBranchRequest . Builder setViewValue ( int value )
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;
Parameter
Name Description
valueint The enum numeric value on the wire for view to set.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-16 UTC."],[],[],null,[]]
