Class ListPropertiesRequest.Builder (0.59.0)

public static final class ListPropertiesRequest.Builder extends GeneratedMessageV3.Builder<ListPropertiesRequest.Builder> implements ListPropertiesRequestOrBuilder

Request message for ListProperties RPC.

Protobuf type google.analytics.admin.v1beta.ListPropertiesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListPropertiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListPropertiesRequest.Builder
Overrides

build()

public ListPropertiesRequest build()
Returns
Type Description
ListPropertiesRequest

buildPartial()

public ListPropertiesRequest buildPartial()
Returns
Type Description
ListPropertiesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public ListPropertiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListPropertiesRequest.Builder
Overrides

clearFilter()

public ListPropertiesRequest.Builder clearFilter()

Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:

`

Filter Description
parent:accounts/123 The account with account id: 123.
parent:properties/123 The property with property id: 123.
ancestor:accounts/123 The account with account id: 123.
firebase_project:project-id The firebase project with id: project-id.
firebase_project:123 The firebase project with number: 123.

`

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListPropertiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListPropertiesRequest.Builder
Overrides

clearPageSize()

public ListPropertiesRequest.Builder clearPageSize()

The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

int32 page_size = 2;

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

clearPageToken()

public ListPropertiesRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

clearShowDeleted()

public ListPropertiesRequest.Builder clearShowDeleted()

Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

bool show_deleted = 4;

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

clone()

public ListPropertiesRequest.Builder clone()
Returns
Type Description
ListPropertiesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListPropertiesRequest getDefaultInstanceForType()
Returns
Type Description
ListPropertiesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:

`

Filter Description
parent:accounts/123 The account with account id: 123.
parent:properties/123 The property with property id: 123.
ancestor:accounts/123 The account with account id: 123.
firebase_project:project-id The firebase project with id: project-id.
firebase_project:123 The firebase project with number: 123.

`

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:

`

Filter Description
parent:accounts/123 The account with account id: 123.
parent:properties/123 The property with property id: 123.
ancestor:accounts/123 The account with account id: 123.
firebase_project:project-id The firebase project with id: project-id.
firebase_project:123 The firebase project with number: 123.

`

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getShowDeleted()

public boolean getShowDeleted()

Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

bool show_deleted = 4;

Returns
Type Description
boolean

The showDeleted.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListPropertiesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListPropertiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListPropertiesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListPropertiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListPropertiesRequest.Builder
Overrides

setFilter(String value)

public ListPropertiesRequest.Builder setFilter(String value)

Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:

`

Filter Description
parent:accounts/123 The account with account id: 123.
parent:properties/123 The property with property id: 123.
ancestor:accounts/123 The account with account id: 123.
firebase_project:project-id The firebase project with id: project-id.
firebase_project:123 The firebase project with number: 123.

`

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListPropertiesRequest.Builder setFilterBytes(ByteString value)

Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:

`

Filter Description
parent:accounts/123 The account with account id: 123.
parent:properties/123 The property with property id: 123.
ancestor:accounts/123 The account with account id: 123.
firebase_project:project-id The firebase project with id: project-id.
firebase_project:123 The firebase project with number: 123.

`

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListPropertiesRequest.Builder setPageSize(int value)

The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListPropertiesRequest.Builder setPageToken(String value)

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListPropertiesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListPropertiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListPropertiesRequest.Builder
Overrides

setShowDeleted(boolean value)

public ListPropertiesRequest.Builder setShowDeleted(boolean value)

Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

bool show_deleted = 4;

Parameter
Name Description
value boolean

The showDeleted to set.

Returns
Type Description
ListPropertiesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListPropertiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListPropertiesRequest.Builder
Overrides