Class SetDefaultBranchRequest (2.48.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
Type Description
int

CATALOG_FIELD_NUMBER

public static final int CATALOG_FIELD_NUMBER
Field Value
Type Description
int

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER
Field Value
Type Description
int

NOTE_FIELD_NUMBER

public static final int NOTE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SetDefaultBranchRequest getDefaultInstance()
Returns
Type Description
SetDefaultBranchRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SetDefaultBranchRequest.Builder newBuilder()
Returns
Type Description
SetDefaultBranchRequest.Builder

newBuilder(SetDefaultBranchRequest prototype)

public static SetDefaultBranchRequest.Builder newBuilder(SetDefaultBranchRequest prototype)
Parameter
Name Description
prototype SetDefaultBranchRequest
Returns
Type Description
SetDefaultBranchRequest.Builder

parseDelimitedFrom(InputStream input)

public static SetDefaultBranchRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SetDefaultBranchRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SetDefaultBranchRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SetDefaultBranchRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SetDefaultBranchRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SetDefaultBranchRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SetDefaultBranchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SetDefaultBranchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SetDefaultBranchRequest> parser()
Returns
Type Description
Parser<SetDefaultBranchRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
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

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.

getParserForType()

public Parser<SetDefaultBranchRequest> getParserForType()
Returns
Type Description
Parser<SetDefaultBranchRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SetDefaultBranchRequest.Builder newBuilderForType()
Returns
Type Description
SetDefaultBranchRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SetDefaultBranchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SetDefaultBranchRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SetDefaultBranchRequest.Builder toBuilder()
Returns
Type Description
SetDefaultBranchRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException