Package com.google.cloud.retail.v2beta

Class SetDefaultBranchRequest

  • All Implemented Interfaces:
    SetDefaultBranchRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SetDefaultBranchRequest
extends com.google.protobuf.GeneratedMessageV3
implements SetDefaultBranchRequestOrBuilder
     Request message to set a specified branch as new default_branch.
    Protobuf type google.cloud.retail.v2beta.SetDefaultBranchRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SetDefaultBranchRequest.Builder
      Request message to set a specified branch as new default_branch.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BRANCH_ID_FIELD_NUMBER  
      static int CATALOG_FIELD_NUMBER  
      static int FORCE_FIELD_NUMBER  
      static int NOTE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getCatalog in interface SetDefaultBranchRequestOrBuilder
        Returns:
        The catalog.

      • getCatalogBytes

        public com.google.protobuf.ByteString getCatalogBytes()
         Full resource name of the catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCatalogBytes in interface SetDefaultBranchRequestOrBuilder
        Returns:
        The bytes for catalog.

      • 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][google.cloud.retail.v2beta.SetDefaultBranchRequest.force] is not
 set, a FAILED_PRECONDITION error is returned.
        string branch_id = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        getBranchId in interface SetDefaultBranchRequestOrBuilder
        Returns:
        The branchId.

      • getBranchIdBytes

        public com.google.protobuf.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][google.cloud.retail.v2beta.SetDefaultBranchRequest.force] is not
 set, a FAILED_PRECONDITION error is returned.
        string branch_id = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        getBranchIdBytes in interface SetDefaultBranchRequestOrBuilder
        Returns:
        The bytes for branchId.

      • getNote

        public String getNote()
         Some note on this request, this can be retrieved by
 [CatalogService.GetDefaultBranch][google.cloud.retail.v2beta.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;
        Specified by:
        getNote in interface SetDefaultBranchRequestOrBuilder
        Returns:
        The note.

      • getNoteBytes

        public com.google.protobuf.ByteString getNoteBytes()
         Some note on this request, this can be retrieved by
 [CatalogService.GetDefaultBranch][google.cloud.retail.v2beta.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;
        Specified by:
        getNoteBytes in interface SetDefaultBranchRequestOrBuilder
        Returns:
        The bytes for note.

      • getForce

        public boolean getForce()
         If set to true, it permits switching to a branch with
 [branch_id][google.cloud.retail.v2beta.SetDefaultBranchRequest.branch_id]
 even if it has no sufficient active products.
        bool force = 4;
        Specified by:
        getForce in interface SetDefaultBranchRequestOrBuilder
        Returns:
        The force.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SetDefaultBranchRequest parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetDefaultBranchRequest parseFrom​(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetDefaultBranchRequest parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetDefaultBranchRequest parseFrom​(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetDefaultBranchRequest parseFrom​(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SetDefaultBranchRequest parseFrom​(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public SetDefaultBranchRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public SetDefaultBranchRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected SetDefaultBranchRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SetDefaultBranchRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public SetDefaultBranchRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder