public interface UserOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getActive()
public abstract boolean getActive()Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.
optional bool active = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The active. |
getDisplayName()
public abstract String getDisplayName()Required. The name of the User. It has a maximum length of 128 characters.
optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()Required. The name of the User. It has a maximum length of 128 characters.
optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEmail()
public abstract String getEmail()Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
optional string email = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The email. |
getEmailBytes()
public abstract ByteString getEmailBytes()Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
optional string email = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for email. |
getExternalId()
public abstract String getExternalId()Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
optional string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The externalId. |
getExternalIdBytes()
public abstract ByteString getExternalIdBytes()Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
optional string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for externalId. |
getName()
public abstract String getName() Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Identifier. The resource name of the User.
Format: networks/{network_code}/users/{user_id}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOrdersUiLocalTimeZone()
public abstract String getOrdersUiLocalTimeZone()Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
optional string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The ordersUiLocalTimeZone. |
getOrdersUiLocalTimeZoneBytes()
public abstract ByteString getOrdersUiLocalTimeZoneBytes()Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
optional string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for ordersUiLocalTimeZone. |
getRole()
public abstract String getRole()Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
optional string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The role. |
getRoleBytes()
public abstract ByteString getRoleBytes()Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
optional string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for role. |
getServiceAccount()
public abstract boolean getServiceAccount()Output only. Whether the user is an OAuth2 service account user. Service account users can only be added through the UI.
optional bool service_account = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The serviceAccount. |
getUserId()
public abstract long getUserId() Output only. User ID.
optional int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long |
The userId. |
hasActive()
public abstract boolean hasActive()Output only. Specifies whether or not the User is active. An inactive user cannot log in to the system or perform any operations.
optional bool active = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the active field is set. |
hasDisplayName()
public abstract boolean hasDisplayName()Required. The name of the User. It has a maximum length of 128 characters.
optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the displayName field is set. |
hasEmail()
public abstract boolean hasEmail()Required. The email or login of the User. In order to create a new user, you must already have a Google Account.
optional string email = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the email field is set. |
hasExternalId()
public abstract boolean hasExternalId()Optional. An identifier for the User that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
optional string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the externalId field is set. |
hasOrdersUiLocalTimeZone()
public abstract boolean hasOrdersUiLocalTimeZone()Optional. The IANA Time Zone Database time zone, e.g. "America/New_York", used in the orders and line items UI for this User. If not provided, the UI then defaults to using the Network's timezone. This setting only affects the UI for this user and does not affect the timezone of any dates and times returned in API responses.
optional string orders_ui_local_time_zone = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ordersUiLocalTimeZone field is set. |
hasRole()
public abstract boolean hasRole()Required. The unique Role ID of the User. Roles that are created by Google will have negative IDs.
optional string role = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the role field is set. |
hasServiceAccount()
public abstract boolean hasServiceAccount()Output only. Whether the user is an OAuth2 service account user. Service account users can only be added through the UI.
optional bool service_account = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the serviceAccount field is set. |
hasUserId()
public abstract boolean hasUserId() Output only. User ID.
optional int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the userId field is set. |