public static final class User.Builder extends GeneratedMessageV3.Builder<User.Builder> implements UserOrBuilder
The User
message represents a user associated with a Merchant Center
account. It is used to manage user permissions and access rights within the
account. For more information, see Frequently asked questions about people
and access levels.
Protobuf type google.shopping.merchant.accounts.v1.User
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > User.BuilderImplements
UserOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAccessRights(AccessRight value)
public User.Builder addAccessRights(AccessRight value)
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
AccessRight The accessRights to add. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
addAccessRightsValue(int value)
public User.Builder addAccessRightsValue(int value)
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for accessRights to add. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
addAllAccessRights(Iterable<? extends AccessRight> values)
public User.Builder addAllAccessRights(Iterable<? extends AccessRight> values)
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.accounts.v1.AccessRight> The accessRights to add. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
addAllAccessRightsValue(Iterable<Integer> values)
public User.Builder addAllAccessRightsValue(Iterable<Integer> values)
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
values |
Iterable<Integer> The enum numeric values on the wire for accessRights to add. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public User.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
User.Builder |
build()
public User build()
Returns | |
---|---|
Type | Description |
User |
buildPartial()
public User buildPartial()
Returns | |
---|---|
Type | Description |
User |
clear()
public User.Builder clear()
Returns | |
---|---|
Type | Description |
User.Builder |
clearAccessRights()
public User.Builder clearAccessRights()
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public User.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
User.Builder |
clearName()
public User.Builder clearName()
Identifier. The resource name of the user.
Format: accounts/{account}/user/{email}
Use me
to refer to your own email address, for example
accounts/{account}/users/me
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public User.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
User.Builder |
clearState()
public User.Builder clearState()
Output only. The state of the user.
.google.shopping.merchant.accounts.v1.User.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
clone()
public User.Builder clone()
Returns | |
---|---|
Type | Description |
User.Builder |
getAccessRights(int index)
public AccessRight getAccessRights(int index)
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
AccessRight |
The accessRights at the given index. |
getAccessRightsCount()
public int getAccessRightsCount()
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int |
The count of accessRights. |
getAccessRightsList()
public List<AccessRight> getAccessRightsList()
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
List<AccessRight> |
A list containing the accessRights. |
getAccessRightsValue(int index)
public int getAccessRightsValue(int index)
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire of accessRights at the given index. |
getAccessRightsValueList()
public List<Integer> getAccessRightsValueList()
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for accessRights. |
getDefaultInstanceForType()
public User getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
User |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getName()
public String getName()
Identifier. The resource name of the user.
Format: accounts/{account}/user/{email}
Use me
to refer to your own email address, for example
accounts/{account}/users/me
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Identifier. The resource name of the user.
Format: accounts/{account}/user/{email}
Use me
to refer to your own email address, for example
accounts/{account}/users/me
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getState()
public User.State getState()
Output only. The state of the user.
.google.shopping.merchant.accounts.v1.User.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
User.State |
The state. |
getStateValue()
public int getStateValue()
Output only. The state of the user.
.google.shopping.merchant.accounts.v1.User.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for state. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public User.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
User.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public User.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
User.Builder |
mergeFrom(User other)
public User.Builder mergeFrom(User other)
Parameter | |
---|---|
Name | Description |
other |
User |
Returns | |
---|---|
Type | Description |
User.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final User.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
User.Builder |
setAccessRights(int index, AccessRight value)
public User.Builder setAccessRights(int index, AccessRight value)
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
AccessRight The accessRights to set. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
setAccessRightsValue(int index, int value)
public User.Builder setAccessRightsValue(int index, int value)
Required. The access rights the user has.
repeated .google.shopping.merchant.accounts.v1.AccessRight access_rights = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
int The enum numeric value on the wire for accessRights to set. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public User.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
User.Builder |
setName(String value)
public User.Builder setName(String value)
Identifier. The resource name of the user.
Format: accounts/{account}/user/{email}
Use me
to refer to your own email address, for example
accounts/{account}/users/me
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public User.Builder setNameBytes(ByteString value)
Identifier. The resource name of the user.
Format: accounts/{account}/user/{email}
Use me
to refer to your own email address, for example
accounts/{account}/users/me
.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public User.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
User.Builder |
setState(User.State value)
public User.Builder setState(User.State value)
Output only. The state of the user.
.google.shopping.merchant.accounts.v1.User.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
User.State The state to set. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
setStateValue(int value)
public User.Builder setStateValue(int value)
Output only. The state of the user.
.google.shopping.merchant.accounts.v1.User.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for state to set. |
Returns | |
---|---|
Type | Description |
User.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final User.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
User.Builder |