Class ListPropertiesRequest.Builder (0.34.0)

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

Request message for ListProperties RPC.

Protobuf type google.analytics.admin.v1alpha.ListPropertiesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListPropertiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListPropertiesRequest.Builder
Overrides

build()

public ListPropertiesRequest build()
Returns
TypeDescription
ListPropertiesRequest

buildPartial()

public ListPropertiesRequest buildPartial()
Returns
TypeDescription
ListPropertiesRequest

clear()

public ListPropertiesRequest.Builder clear()
Returns
TypeDescription
ListPropertiesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListPropertiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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:

`

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

`

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

Returns
TypeDescription
ListPropertiesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListPropertiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ListPropertiesRequest.Builder

This builder for chaining.

clone()

public ListPropertiesRequest.Builder clone()
Returns
TypeDescription
ListPropertiesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListPropertiesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListPropertiesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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:

`

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

`

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

Returns
TypeDescription
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:

`

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

`

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The showDeleted.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListPropertiesRequest other)

public ListPropertiesRequest.Builder mergeFrom(ListPropertiesRequest other)
Parameter
NameDescription
otherListPropertiesRequest
Returns
TypeDescription
ListPropertiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListPropertiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListPropertiesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListPropertiesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListPropertiesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListPropertiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListPropertiesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListPropertiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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:

`

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

`

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

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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:

`

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

`

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

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueboolean

The showDeleted to set.

Returns
TypeDescription
ListPropertiesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListPropertiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListPropertiesRequest.Builder
Overrides