public static final class SetDefaultBranchRequest.Builder extends GeneratedMessageV3.Builder<SetDefaultBranchRequest.Builder> implements SetDefaultBranchRequestOrBuilderRequest message to set a specified branch as new default_branch.
Protobuf type google.cloud.retail.v2alpha.SetDefaultBranchRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SetDefaultBranchRequest.BuilderImplements
SetDefaultBranchRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SetDefaultBranchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
build()
public SetDefaultBranchRequest build()| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest | |
buildPartial()
public SetDefaultBranchRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest | |
clear()
public SetDefaultBranchRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
clearBranchId()
public SetDefaultBranchRequest.Builder clearBranchId()The final component of the resource name of a branch.
This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
string branch_id = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
clearCatalog()
public SetDefaultBranchRequest.Builder clearCatalog() Full resource name of the catalog, such as
projects/*/locations/global/catalogs/default_catalog.
string catalog = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SetDefaultBranchRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
clearForce()
public SetDefaultBranchRequest.Builder clearForce()If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.
bool force = 4;
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
clearNote()
public SetDefaultBranchRequest.Builder clearNote()Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs.
This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string note = 3;
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SetDefaultBranchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
clone()
public SetDefaultBranchRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
getBranchId()
public String getBranchId()The final component of the resource name of a branch.
This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
string branch_id = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The branchId. |
getBranchIdBytes()
public ByteString getBranchIdBytes()The final component of the resource name of a branch.
This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
string branch_id = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for branchId. |
getCatalog()
public String getCatalog() Full resource name of the catalog, such as
projects/*/locations/global/catalogs/default_catalog.
string catalog = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The catalog. |
getCatalogBytes()
public ByteString getCatalogBytes() Full resource name of the catalog, such as
projects/*/locations/global/catalogs/default_catalog.
string catalog = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for catalog. |
getDefaultInstanceForType()
public SetDefaultBranchRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getForce()
public boolean getForce()If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.
bool force = 4;
| Returns | |
|---|---|
| Type | Description |
boolean | The force. |
getNote()
public String getNote()Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs.
This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string note = 3;
| Returns | |
|---|---|
| Type | Description |
String | The note. |
getNoteBytes()
public ByteString getNoteBytes()Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs.
This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string note = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for note. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(SetDefaultBranchRequest other)
public SetDefaultBranchRequest.Builder mergeFrom(SetDefaultBranchRequest other)| Parameter | |
|---|---|
| Name | Description |
other | SetDefaultBranchRequest |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SetDefaultBranchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public SetDefaultBranchRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SetDefaultBranchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
setBranchId(String value)
public SetDefaultBranchRequest.Builder setBranchId(String value)The final component of the resource name of a branch.
This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
string branch_id = 2 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe branchId to set. |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
setBranchIdBytes(ByteString value)
public SetDefaultBranchRequest.Builder setBranchIdBytes(ByteString value)The final component of the resource name of a branch.
This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
string branch_id = 2 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for branchId to set. |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
setCatalog(String value)
public SetDefaultBranchRequest.Builder setCatalog(String value) Full resource name of the catalog, such as
projects/*/locations/global/catalogs/default_catalog.
string catalog = 1 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe catalog to set. |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
setCatalogBytes(ByteString value)
public SetDefaultBranchRequest.Builder setCatalogBytes(ByteString value) Full resource name of the catalog, such as
projects/*/locations/global/catalogs/default_catalog.
string catalog = 1 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for catalog to set. |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SetDefaultBranchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
setForce(boolean value)
public SetDefaultBranchRequest.Builder setForce(boolean value)If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.
bool force = 4;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe force to set. |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
setNote(String value)
public SetDefaultBranchRequest.Builder setNote(String value)Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs.
This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string note = 3;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe note to set. |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
setNoteBytes(ByteString value)
public SetDefaultBranchRequest.Builder setNoteBytes(ByteString value)Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs.
This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string note = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for note to set. |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SetDefaultBranchRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final SetDefaultBranchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SetDefaultBranchRequest.Builder | |