Interface UserOrBuilder (0.13.0) 

public interface UserOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

int64 user_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The userId.