Class ListOrganizationEventsRequest.Builder (0.21.0)

public static final class ListOrganizationEventsRequest.Builder extends GeneratedMessageV3.Builder<ListOrganizationEventsRequest.Builder> implements ListOrganizationEventsRequestOrBuilder

Message for requesting list of organization events.

Protobuf type google.cloud.servicehealth.v1.ListOrganizationEventsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListOrganizationEventsRequest build()
Returns
Type Description
ListOrganizationEventsRequest

buildPartial()

public ListOrganizationEventsRequest buildPartial()
Returns
Type Description
ListOrganizationEventsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListOrganizationEventsRequest.Builder clearFilter()

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

  • field=value for category and state
  • field &lt;, >, &lt;=, or >= value for update_time

    Examples: category=INCIDENT, update_time>="2000-01-01T11:30:00-04:00"

    Multiple filter queries are space-separated. 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
ListOrganizationEventsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListOrganizationEventsRequest.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
ListOrganizationEventsRequest.Builder

This builder for chaining.

clearPageToken()

public ListOrganizationEventsRequest.Builder clearPageToken()

Optional. A token identifying a page of results the server should return.

Provide Page token returned by a previous ListOrganizationEvents call to retrieve the next page of results.

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

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

Returns
Type Description
ListOrganizationEventsRequest.Builder

This builder for chaining.

clearParent()

public ListOrganizationEventsRequest.Builder clearParent()

Required. Parent value using the form organizations/{organization_id}/locations/{location}/organizationEvents.

organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.<br> 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
ListOrganizationEventsRequest.Builder

This builder for chaining.

clearView()

public ListOrganizationEventsRequest.Builder clearView()

Optional. OrganizationEvent fields to include in response.

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

Returns
Type Description
ListOrganizationEventsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListOrganizationEventsRequest getDefaultInstanceForType()
Returns
Type Description
ListOrganizationEventsRequest

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:

  • field=value for category and state
  • field &lt;, >, &lt;=, or >= value for update_time

    Examples: category=INCIDENT, update_time>="2000-01-01T11:30:00-04:00"

    Multiple filter queries are space-separated. 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:

  • field=value for category and state
  • field &lt;, >, &lt;=, or >= value for update_time

    Examples: category=INCIDENT, update_time>="2000-01-01T11:30:00-04:00"

    Multiple filter queries are space-separated. 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 ListOrganizationEvents call to retrieve the next page of results.

When paginating, all other parameters provided to ListOrganizationEvents 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 ListOrganizationEvents call to retrieve the next page of results.

When paginating, all other parameters provided to ListOrganizationEvents 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 organizations/{organization_id}/locations/{location}/organizationEvents.

organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.<br> 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 organizations/{organization_id}/locations/{location}/organizationEvents.

organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.<br> 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 OrganizationEventView getView()

Optional. OrganizationEvent fields to include in response.

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

Returns
Type Description
OrganizationEventView

The view.

getViewValue()

public int getViewValue()

Optional. OrganizationEvent fields to include in response.

.google.cloud.servicehealth.v1.OrganizationEventView 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(ListOrganizationEventsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListOrganizationEventsRequest.Builder setFilter(String value)

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

  • field=value for category and state
  • field &lt;, >, &lt;=, or >= value for update_time

    Examples: category=INCIDENT, update_time>="2000-01-01T11:30:00-04:00"

    Multiple filter queries are space-separated. 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
ListOrganizationEventsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListOrganizationEventsRequest.Builder setFilterBytes(ByteString value)

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

  • field=value for category and state
  • field &lt;, >, &lt;=, or >= value for update_time

    Examples: category=INCIDENT, update_time>="2000-01-01T11:30:00-04:00"

    Multiple filter queries are space-separated. 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
ListOrganizationEventsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListOrganizationEventsRequest.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
ListOrganizationEventsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListOrganizationEventsRequest.Builder setPageToken(String value)

Optional. A token identifying a page of results the server should return.

Provide Page token returned by a previous ListOrganizationEvents call to retrieve the next page of results.

When paginating, all other parameters provided to ListOrganizationEvents 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
ListOrganizationEventsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListOrganizationEventsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A token identifying a page of results the server should return.

Provide Page token returned by a previous ListOrganizationEvents call to retrieve the next page of results.

When paginating, all other parameters provided to ListOrganizationEvents 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
ListOrganizationEventsRequest.Builder

This builder for chaining.

setParent(String value)

public ListOrganizationEventsRequest.Builder setParent(String value)

Required. Parent value using the form organizations/{organization_id}/locations/{location}/organizationEvents.

organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.<br> 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
ListOrganizationEventsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListOrganizationEventsRequest.Builder setParentBytes(ByteString value)

Required. Parent value using the form organizations/{organization_id}/locations/{location}/organizationEvents.

organization_id - ID (number) of the project that contains the event. To get your organization_id, see Getting your organization resource ID.<br> 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
ListOrganizationEventsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setView(OrganizationEventView value)

public ListOrganizationEventsRequest.Builder setView(OrganizationEventView value)

Optional. OrganizationEvent fields to include in response.

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

Parameter
Name Description
value OrganizationEventView

The view to set.

Returns
Type Description
ListOrganizationEventsRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListOrganizationEventsRequest.Builder setViewValue(int value)

Optional. OrganizationEvent fields to include in response.

.google.cloud.servicehealth.v1.OrganizationEventView 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
ListOrganizationEventsRequest.Builder

This builder for chaining.