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
CATALOG_FIELD_NUMBER
public static final int CATALOG_FIELD_NUMBER
Field Value
FORCE_FIELD_NUMBER
public static final int FORCE_FIELD_NUMBER
Field Value
NOTE_FIELD_NUMBER
public static final int NOTE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SetDefaultBranchRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SetDefaultBranchRequest.Builder newBuilder()
Returns
newBuilder(SetDefaultBranchRequest prototype)
public static SetDefaultBranchRequest.Builder newBuilder(SetDefaultBranchRequest prototype)
Parameter
Returns
public static SetDefaultBranchRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SetDefaultBranchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SetDefaultBranchRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SetDefaultBranchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SetDefaultBranchRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SetDefaultBranchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SetDefaultBranchRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SetDefaultBranchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SetDefaultBranchRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SetDefaultBranchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SetDefaultBranchRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SetDefaultBranchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SetDefaultBranchRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
getDefaultInstanceForType()
public SetDefaultBranchRequest getDefaultInstanceForType()
Returns
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
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
getParserForType()
public Parser<SetDefaultBranchRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SetDefaultBranchRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SetDefaultBranchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SetDefaultBranchRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions