public static final class GetBranchRequest.Builder extends GeneratedMessage.Builder<GetBranchRequest.Builder> implements GetBranchRequestOrBuilderRequest for BranchService.GetBranch method.
Protobuf type google.cloud.retail.v2alpha.GetBranchRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > GetBranchRequest.BuilderImplements
GetBranchRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public GetBranchRequest build()| Returns | |
|---|---|
| Type | Description |
GetBranchRequest |
|
buildPartial()
public GetBranchRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
GetBranchRequest |
|
clear()
public GetBranchRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
|
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
This builder for chaining. |
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;
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public GetBranchRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GetBranchRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(GetBranchRequest other)
public GetBranchRequest.Builder mergeFrom(GetBranchRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
GetBranchRequest |
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GetBranchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GetBranchRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
|
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 |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
This builder for chaining. |
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 |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
This builder for chaining. |
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 |
value |
BranchViewThe view to set. |
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
This builder for chaining. |
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 |
value |
intThe enum numeric value on the wire for view to set. |
| Returns | |
|---|---|
| Type | Description |
GetBranchRequest.Builder |
This builder for chaining. |