Class ListSubscriptionsRequest.Builder (0.80.0)

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

Message for listing subscriptions.

Protobuf type google.cloud.bigquery.analyticshub.v1.ListSubscriptionsRequest

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()

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange

    Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above.

    In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"

  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"

string filter = 2;

Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

clearPageSize()

public ListSubscriptionsRequest.Builder clearPageSize()

The maximum number of results to return in a single response page.

int32 page_size = 3;

Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListSubscriptionsRequest.Builder clearPageToken()

Page token, returned by a previous call.

string page_token = 4;

Returns
Type Description
ListSubscriptionsRequest.Builder

This builder for chaining.

clearParent()

public ListSubscriptionsRequest.Builder clearParent()

Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us

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()

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange

    Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above.

    In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"

  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange

    Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above.

    In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"

  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of results to return in a single response page.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Page token, returned by a previous call.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Page token, returned by a previous call.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us

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 resource path of the subscription. e.g. projects/myproject/locations/us

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)

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange

    Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above.

    In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"

  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"

string filter = 2;

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)

An expression for filtering the results of the request. Eligible fields for filtering are:

  • listing
  • data_exchange

    Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above.

    In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters:

  • data_exchange="projects/myproject/locations/us/dataExchanges/123"

  • listing="projects/123/locations/us/dataExchanges/456/listings/789"
  • "projects/myproject/locations/us/dataExchanges/123"

string filter = 2;

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)

The maximum number of results to return in a single response page.

int32 page_size = 3;

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)

Page token, returned by a previous call.

string page_token = 4;

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)

Page token, returned by a previous call.

string page_token = 4;

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 resource path of the subscription. e.g. projects/myproject/locations/us

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 resource path of the subscription. e.g. projects/myproject/locations/us

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.