Class ListNativeDashboardsRequest.Builder (0.31.0)

public static final class ListNativeDashboardsRequest.Builder extends GeneratedMessage.Builder<ListNativeDashboardsRequest.Builder> implements ListNativeDashboardsRequestOrBuilder

Request message to list dashboards.

Protobuf type google.cloud.chronicle.v1.ListNativeDashboardsRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListNativeDashboardsRequest build()
Returns
Type Description
ListNativeDashboardsRequest

buildPartial()

public ListNativeDashboardsRequest buildPartial()
Returns
Type Description
ListNativeDashboardsRequest

clear()

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

clearPageSize()

public ListNativeDashboardsRequest.Builder clearPageSize()

Optional. The maximum number of dashboards to return. The service may return fewer than this value.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

clearPageToken()

public ListNativeDashboardsRequest.Builder clearPageToken()

Optional. A page token, received from a previous ListDashboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

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

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

clearParent()

public ListNativeDashboardsRequest.Builder clearParent()

Required. The parent owning this dashboard collection. Format: projects/{project}/locations/{location}/instances/{instance}

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

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

clearView()

public ListNativeDashboardsRequest.Builder clearView()

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

.google.cloud.chronicle.v1.NativeDashboardView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListNativeDashboardsRequest getDefaultInstanceForType()
Returns
Type Description
ListNativeDashboardsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Optional. The maximum number of dashboards to return. The service may return fewer than this value.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous ListDashboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous ListDashboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent owning this dashboard collection. Format: projects/{project}/locations/{location}/instances/{instance}

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 owning this dashboard collection. Format: projects/{project}/locations/{location}/instances/{instance}

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

Returns
Type Description
ByteString

The bytes for parent.

getView()

public NativeDashboardView getView()

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

.google.cloud.chronicle.v1.NativeDashboardView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NativeDashboardView

The view.

getViewValue()

public int getViewValue()

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

.google.cloud.chronicle.v1.NativeDashboardView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListNativeDashboardsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setPageSize(int value)

public ListNativeDashboardsRequest.Builder setPageSize(int value)

Optional. The maximum number of dashboards to return. The service may return fewer than this value.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListNativeDashboardsRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous ListDashboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListNativeDashboardsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous ListDashboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

setParent(String value)

public ListNativeDashboardsRequest.Builder setParent(String value)

Required. The parent owning this dashboard collection. Format: projects/{project}/locations/{location}/instances/{instance}

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListNativeDashboardsRequest.Builder setParentBytes(ByteString value)

Required. The parent owning this dashboard collection. Format: projects/{project}/locations/{location}/instances/{instance}

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

This builder for chaining.

setView(NativeDashboardView value)

public ListNativeDashboardsRequest.Builder setView(NativeDashboardView value)

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

.google.cloud.chronicle.v1.NativeDashboardView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value NativeDashboardView

The view to set.

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListNativeDashboardsRequest.Builder setViewValue(int value)

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

.google.cloud.chronicle.v1.NativeDashboardView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for view to set.

Returns
Type Description
ListNativeDashboardsRequest.Builder

This builder for chaining.