Class ListSubscriptionsRequest.Builder (0.2.0) 

public static final class ListSubscriptionsRequest.Builder extends GeneratedMessage.Builder<ListSubscriptionsRequest.Builder> implements ListSubscriptionsRequestOrBuilder

Request message for ListSubscriptions.

Protobuf type google.devicesandservices.health.v4.ListSubscriptionsRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListSubscriptionsRequest.Builder

Static Methods

getDescriptor()

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

Methods

build()

public ListSubscriptionsRequest build()
Returns
Type Description
ListSubscriptionsRequest

buildPartial()

public ListSubscriptionsRequest buildPartial()
Returns
Type Description
ListSubscriptionsRequest

clear()

public ListSubscriptionsRequest.Builder clear()
Returns
Type Description
ListSubscriptionsRequest.Builder
Overrides

clearFilter()

public ListSubscriptionsRequest.Builder clearFilter()

Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields:

  • user

  • data_type

    The user identifier (e.g., user1 in users/user1) refers to the public healthUserId

    Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")

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

Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

clearPageSize()

public ListSubscriptionsRequest.Builder clearPageSize()

Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions 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
ListSubscriptionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListSubscriptionsRequest.Builder clearPageToken()

Optional. A page token, received from a previous ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions must match the call that provided the page token.

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

Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

clearParent()

public ListSubscriptionsRequest.Builder clearParent()

Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise.

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

Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListSubscriptionsRequest getDefaultInstanceForType()
Returns
Type Description
ListSubscriptionsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields:

  • user

  • data_type

    The user identifier (e.g., user1 in users/user1) refers to the public healthUserId

    Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields:

  • user

  • data_type

    The user identifier (e.g., user1 in users/user1) refers to the public healthUserId

    Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")

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 subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions 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 ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions 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 ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions 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 parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise.

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListSubscriptionsRequest other)

public ListSubscriptionsRequest.Builder mergeFrom(ListSubscriptionsRequest other)
Parameter
Name Description
other ListSubscriptionsRequest
Returns
Type Description
ListSubscriptionsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListSubscriptionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSubscriptionsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListSubscriptionsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListSubscriptionsRequest.Builder
Overrides

setFilter(String value)

public ListSubscriptionsRequest.Builder setFilter(String value)

Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields:

  • user

  • data_type

    The user identifier (e.g., user1 in users/user1) refers to the public healthUserId

    Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListSubscriptionsRequest.Builder setFilterBytes(ByteString value)

Optional. A filter to apply to the list of subscriptions. The filter syntax is described in https://google.aip.dev/160. The filter can be applied to the following fields:

  • user

  • data_type

    The user identifier (e.g., user1 in users/user1) refers to the public healthUserId

    Example: user = "users/user1" Example: user = "users/user1" OR user = "users/user2" Example: user = "users/user1" AND (data_type = "sleep" OR data_type = "weight")

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListSubscriptionsRequest.Builder setPageSize(int value)

Optional. The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions 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];

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListSubscriptionsRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions must match the call that provided the page token.

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

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListSubscriptionsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous ListSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSubscriptions must match the call that provided the page token.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

setParent(String value)

public ListSubscriptionsRequest.Builder setParent(String value)

Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise.

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListSubscriptionsRequest.Builder setParentBytes(ByteString value)

Required. The parent subscriber. Format: projects/{project}/subscribers/{subscriber} The {subscriber} ID is user-settable (4-36 characters, matching /a-z/) if provided during creation, or system-generated otherwise.

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

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.