Class SetDefaultBranchRequest (2.21.0)

public final class SetDefaultBranchRequest extends GeneratedMessageV3 implements SetDefaultBranchRequestOrBuilder

Request message to set a specified branch as new default_branch.

Protobuf type google.cloud.retail.v2.SetDefaultBranchRequest

Static Fields

BRANCH_ID_FIELD_NUMBER

public static final int BRANCH_ID_FIELD_NUMBER
Field Value
TypeDescription
int

CATALOG_FIELD_NUMBER

public static final int CATALOG_FIELD_NUMBER
Field Value
TypeDescription
int

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER
Field Value
TypeDescription
int

NOTE_FIELD_NUMBER

public static final int NOTE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SetDefaultBranchRequest getDefaultInstance()
Returns
TypeDescription
SetDefaultBranchRequest

getDescriptor()

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

newBuilder()

public static SetDefaultBranchRequest.Builder newBuilder()
Returns
TypeDescription
SetDefaultBranchRequest.Builder

newBuilder(SetDefaultBranchRequest prototype)

public static SetDefaultBranchRequest.Builder newBuilder(SetDefaultBranchRequest prototype)
Parameter
NameDescription
prototypeSetDefaultBranchRequest
Returns
TypeDescription
SetDefaultBranchRequest.Builder

parseDelimitedFrom(InputStream input)

public static SetDefaultBranchRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SetDefaultBranchRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SetDefaultBranchRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SetDefaultBranchRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SetDefaultBranchRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SetDefaultBranchRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SetDefaultBranchRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SetDefaultBranchRequest> parser()
Returns
TypeDescription
Parser<SetDefaultBranchRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

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.

getParserForType()

public Parser<SetDefaultBranchRequest> getParserForType()
Returns
TypeDescription
Parser<SetDefaultBranchRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SetDefaultBranchRequest.Builder newBuilderForType()
Returns
TypeDescription
SetDefaultBranchRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SetDefaultBranchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SetDefaultBranchRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SetDefaultBranchRequest.Builder toBuilder()
Returns
TypeDescription
SetDefaultBranchRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException