Class ListEventsRequest.Builder (0.19.0)

public static final class ListEventsRequest.Builder extends GeneratedMessageV3.Builder<ListEventsRequest.Builder> implements ListEventsRequestOrBuilder

Protobuf type google.cloud.servicehealth.v1.ListEventsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListEventsRequest build()
Returns
Type Description
ListEventsRequest

buildPartial()

public ListEventsRequest buildPartial()
Returns
Type Description
ListEventsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListEventsRequest.Builder clearFilter()

Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: <br>

  • field=value for category and state<br>
  • field &lt;, >, &lt;=, or >= value for update_time <br> Examples: category=INCIDENT, update_time>=2000-01-01T11:30:00-04:00 <br>

    Multiple filter queries are separated by spaces. Example: category=INCIDENT state=ACTIVE.

    By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

    Filter is supported for the following fields: category, state, update_time

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListEventsRequest.Builder clearPageSize()

Optional. The maximum number of events that should be returned. Acceptable values are 1 to 100, inclusive. (The default value is 10.) If more results are available, the service returns a next_page_token that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested page_size.

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

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

clearPageToken()

public ListEventsRequest.Builder clearPageToken()

Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous ListEvents call to retrieve the next page of results. When paginating, all other parameters provided to ListEvents must match the call that provided the page token.

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

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

clearParent()

public ListEventsRequest.Builder clearParent()

Required. Parent value using the form projects/{project_id}/locations/{location}/events.

project_id - ID of the project for which to list service health events. location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.

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

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

clearView()

public ListEventsRequest.Builder clearView()

Optional. Event fields to include in response.

.google.cloud.servicehealth.v1.EventView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListEventsRequest getDefaultInstanceForType()
Returns
Type Description
ListEventsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: <br>

  • field=value for category and state<br>
  • field &lt;, >, &lt;=, or >= value for update_time <br> Examples: category=INCIDENT, update_time>=2000-01-01T11:30:00-04:00 <br>

    Multiple filter queries are separated by spaces. Example: category=INCIDENT state=ACTIVE.

    By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

    Filter is supported for the following fields: category, state, update_time

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: <br>

  • field=value for category and state<br>
  • field &lt;, >, &lt;=, or >= value for update_time <br> Examples: category=INCIDENT, update_time>=2000-01-01T11:30:00-04:00 <br>

    Multiple filter queries are separated by spaces. Example: category=INCIDENT state=ACTIVE.

    By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

    Filter is supported for the following fields: category, state, update_time

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of events that should be returned. Acceptable values are 1 to 100, inclusive. (The default value is 10.) If more results are available, the service returns a next_page_token that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested page_size.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous ListEvents call to retrieve the next page of results. When paginating, all other parameters provided to ListEvents 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 token identifying a page of results the server should return. Provide Page token returned by a previous ListEvents call to retrieve the next page of results. When paginating, all other parameters provided to ListEvents 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. Parent value using the form projects/{project_id}/locations/{location}/events.

project_id - ID of the project for which to list service health events. location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Parent value using the form projects/{project_id}/locations/{location}/events.

project_id - ID of the project for which to list service health events. location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.

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

Returns
Type Description
ByteString

The bytes for parent.

getView()

public EventView getView()

Optional. Event fields to include in response.

.google.cloud.servicehealth.v1.EventView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventView

The view.

getViewValue()

public int getViewValue()

Optional. Event fields to include in response.

.google.cloud.servicehealth.v1.EventView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListEventsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListEventsRequest.Builder setFilter(String value)

Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: <br>

  • field=value for category and state<br>
  • field &lt;, >, &lt;=, or >= value for update_time <br> Examples: category=INCIDENT, update_time>=2000-01-01T11:30:00-04:00 <br>

    Multiple filter queries are separated by spaces. Example: category=INCIDENT state=ACTIVE.

    By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

    Filter is supported for the following fields: category, state, update_time

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListEventsRequest.Builder setFilterBytes(ByteString value)

Optional. A filter expression that filters resources listed in the response. The expression takes the following forms: <br>

  • field=value for category and state<br>
  • field &lt;, >, &lt;=, or >= value for update_time <br> Examples: category=INCIDENT, update_time>=2000-01-01T11:30:00-04:00 <br>

    Multiple filter queries are separated by spaces. Example: category=INCIDENT state=ACTIVE.

    By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

    Filter is supported for the following fields: category, state, update_time

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListEventsRequest.Builder setPageSize(int value)

Optional. The maximum number of events that should be returned. Acceptable values are 1 to 100, inclusive. (The default value is 10.) If more results are available, the service returns a next_page_token that you can use to get the next page of results in subsequent list requests. The service may return fewer events than the requested page_size.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEventsRequest.Builder setPageToken(String value)

Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous ListEvents call to retrieve the next page of results. When paginating, all other parameters provided to ListEvents 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
ListEventsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEventsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous ListEvents call to retrieve the next page of results. When paginating, all other parameters provided to ListEvents 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
ListEventsRequest.Builder

This builder for chaining.

setParent(String value)

public ListEventsRequest.Builder setParent(String value)

Required. Parent value using the form projects/{project_id}/locations/{location}/events.

project_id - ID of the project for which to list service health events. location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEventsRequest.Builder setParentBytes(ByteString value)

Required. Parent value using the form projects/{project_id}/locations/{location}/events.

project_id - ID of the project for which to list service health events. location - The location to get the service health events from. To retrieve service health events of category = INCIDENT, use location = global.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setView(EventView value)

public ListEventsRequest.Builder setView(EventView value)

Optional. Event fields to include in response.

.google.cloud.servicehealth.v1.EventView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EventView

The view to set.

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListEventsRequest.Builder setViewValue(int value)

Optional. Event fields to include in response.

.google.cloud.servicehealth.v1.EventView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

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

Returns
Type Description
ListEventsRequest.Builder

This builder for chaining.