Class SetDefaultBranchRequest.Builder (2.38.0)

public static final class SetDefaultBranchRequest.Builder extends GeneratedMessageV3.Builder<SetDefaultBranchRequest.Builder> implements SetDefaultBranchRequestOrBuilder

Request message to set a specified branch as new default_branch.

Protobuf type google.cloud.retail.v2.SetDefaultBranchRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SetDefaultBranchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

build()

public SetDefaultBranchRequest build()
Returns
TypeDescription
SetDefaultBranchRequest

buildPartial()

public SetDefaultBranchRequest buildPartial()
Returns
TypeDescription
SetDefaultBranchRequest

clear()

public SetDefaultBranchRequest.Builder clear()
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
SetDefaultBranchRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SetDefaultBranchRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
SetDefaultBranchRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SetDefaultBranchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

clone()

public SetDefaultBranchRequest.Builder clone()
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for catalog.

getDefaultInstanceForType()

public SetDefaultBranchRequest getDefaultInstanceForType()
Returns
TypeDescription
SetDefaultBranchRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for note.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SetDefaultBranchRequest other)

public SetDefaultBranchRequest.Builder mergeFrom(SetDefaultBranchRequest other)
Parameter
NameDescription
otherSetDefaultBranchRequest
Returns
TypeDescription
SetDefaultBranchRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SetDefaultBranchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SetDefaultBranchRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SetDefaultBranchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

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
NameDescription
valueString

The branchId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for branchId to set.

Returns
TypeDescription
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
NameDescription
valueString

The catalog to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for catalog to set.

Returns
TypeDescription
SetDefaultBranchRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SetDefaultBranchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

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
NameDescription
valueboolean

The force to set.

Returns
TypeDescription
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
NameDescription
valueString

The note to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for note to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SetDefaultBranchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides