Class ListDashboardsRequest.Builder (2.56.0)

public static final class ListDashboardsRequest.Builder extends GeneratedMessageV3.Builder<ListDashboardsRequest.Builder> implements ListDashboardsRequestOrBuilder

The ListDashboards request.

Protobuf type google.monitoring.dashboard.v1.ListDashboardsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListDashboardsRequest build()
Returns
Type Description
ListDashboardsRequest

buildPartial()

public ListDashboardsRequest buildPartial()
Returns
Type Description
ListDashboardsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListDashboardsRequest.Builder clearPageSize()

A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.

int32 page_size = 2;

Returns
Type Description
ListDashboardsRequest.Builder

This builder for chaining.

clearPageToken()

public ListDashboardsRequest.Builder clearPageToken()

Optional. If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

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

Returns
Type Description
ListDashboardsRequest.Builder

This builder for chaining.

clearParent()

public ListDashboardsRequest.Builder clearParent()

Required. The scope of the dashboards to list. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Returns
Type Description
ListDashboardsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListDashboardsRequest getDefaultInstanceForType()
Returns
Type Description
ListDashboardsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The scope of the dashboards to list. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The scope of the dashboards to list. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListDashboardsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListDashboardsRequest.Builder setPageSize(int value)

A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListDashboardsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListDashboardsRequest.Builder setPageToken(String value)

Optional. If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListDashboardsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDashboardsRequest.Builder setPageTokenBytes(ByteString value)

Optional. If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListDashboardsRequest.Builder

This builder for chaining.

setParent(String value)

public ListDashboardsRequest.Builder setParent(String value)

Required. The scope of the dashboards to list. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListDashboardsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListDashboardsRequest.Builder setParentBytes(ByteString value)

Required. The scope of the dashboards to list. The format is:

 projects/[PROJECT_ID_OR_NUMBER]

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
ListDashboardsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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