Class ListUserListGlobalLicensesRequest (0.8.0) 

public final class ListUserListGlobalLicensesRequest extends GeneratedMessage implements ListUserListGlobalLicensesRequestOrBuilder

Request to list all UserListGlobalLicense resources for a given account.

Protobuf type google.ads.datamanager.v1.ListUserListGlobalLicensesRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ListUserListGlobalLicensesRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListUserListGlobalLicensesRequest getDefaultInstance()
Returns
Type Description
ListUserListGlobalLicensesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListUserListGlobalLicensesRequest.Builder newBuilder()
Returns
Type Description
ListUserListGlobalLicensesRequest.Builder

newBuilder(ListUserListGlobalLicensesRequest prototype)

public static ListUserListGlobalLicensesRequest.Builder newBuilder(ListUserListGlobalLicensesRequest prototype)
Parameter
Name Description
prototype ListUserListGlobalLicensesRequest
Returns
Type Description
ListUserListGlobalLicensesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListUserListGlobalLicensesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListUserListGlobalLicensesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListUserListGlobalLicensesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListUserListGlobalLicensesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListUserListGlobalLicensesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListUserListGlobalLicensesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListUserListGlobalLicensesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListUserListGlobalLicensesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListUserListGlobalLicensesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListUserListGlobalLicensesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListUserListGlobalLicensesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListUserListGlobalLicensesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserListGlobalLicensesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListUserListGlobalLicensesRequest> parser()
Returns
Type Description
Parser<ListUserListGlobalLicensesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListUserListGlobalLicensesRequest getDefaultInstanceForType()
Returns
Type Description
ListUserListGlobalLicensesRequest

getFilter()

public String getFilter()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported Operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <

  • <=

    Unsupported Fields:

  • name (use get method instead)

  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported Operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <

  • <=

    Unsupported Fields:

  • name (use get method instead)

  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous ListUserListGlobalLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous ListUserListGlobalLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListUserListGlobalLicensesRequest> getParserForType()
Returns
Type Description
Parser<ListUserListGlobalLicensesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListUserListGlobalLicensesRequest.Builder newBuilderForType()
Returns
Type Description
ListUserListGlobalLicensesRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListUserListGlobalLicensesRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListUserListGlobalLicensesRequest.Builder
Overrides

toBuilder()

public ListUserListGlobalLicensesRequest.Builder toBuilder()
Returns
Type Description
ListUserListGlobalLicensesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException