Class ListApiOperationsRequest.Builder (0.4.0) 

public static final class ListApiOperationsRequest.Builder extends GeneratedMessageV3.Builder<ListApiOperationsRequest.Builder> implements ListApiOperationsRequestOrBuilder

The ListApiOperations method's request.

Protobuf type google.cloud.apihub.v1.ListApiOperationsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListApiOperationsRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListApiOperationsRequest build()
Returns
Type Description
ListApiOperationsRequest

buildPartial()

public ListApiOperationsRequest buildPartial()
Returns
Type Description
ListApiOperationsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListApiOperationsRequest.Builder clearFilter()

Optional. An expression that filters the list of ApiOperations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive.

The following fields in the ApiOperation are eligible for filtering:

  • name - The ApiOperation resource name. Allowed comparison operators: =.
  • details.http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: =.
  • details.http_operation.method - The http operation method type. Allowed comparison operators: =.
  • details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: =.

  • create_time - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.

    Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

    Here are a few examples:

  • details.deprecated = True - The ApiOperation is deprecated.

  • details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • details.http_operation.method = GET OR details.http_operation.method = POST. - The http operation of the method of ApiOperation is GET or POST.

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

Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListApiOperationsRequest.Builder clearPageSize()

Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListApiOperationsRequest.Builder clearPageToken()

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

When paginating, all other parameters (except page_size) provided to ListApiOperations must match the call that provided the page token.

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

Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

clearParent()

public ListApiOperationsRequest.Builder clearParent()

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

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

Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListApiOperationsRequest getDefaultInstanceForType()
Returns
Type Description
ListApiOperationsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. An expression that filters the list of ApiOperations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive.

The following fields in the ApiOperation are eligible for filtering:

  • name - The ApiOperation resource name. Allowed comparison operators: =.
  • details.http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: =.
  • details.http_operation.method - The http operation method type. Allowed comparison operators: =.
  • details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: =.

  • create_time - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.

    Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

    Here are a few examples:

  • details.deprecated = True - The ApiOperation is deprecated.

  • details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • details.http_operation.method = GET OR details.http_operation.method = POST. - The http operation of the method of ApiOperation is GET or POST.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. An expression that filters the list of ApiOperations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive.

The following fields in the ApiOperation are eligible for filtering:

  • name - The ApiOperation resource name. Allowed comparison operators: =.
  • details.http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: =.
  • details.http_operation.method - The http operation method type. Allowed comparison operators: =.
  • details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: =.

  • create_time - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.

    Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

    Here are a few examples:

  • details.deprecated = True - The ApiOperation is deprecated.

  • details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • details.http_operation.method = GET OR details.http_operation.method = POST. - The http operation of the method of ApiOperation is GET or POST.

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

When paginating, all other parameters (except page_size) provided to ListApiOperations must match the call that provided the page token.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

When paginating, all other parameters (except page_size) provided to ListApiOperations must match the call that provided the page token.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

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 which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

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(ListApiOperationsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListApiOperationsRequest.Builder setFilter(String value)

Optional. An expression that filters the list of ApiOperations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive.

The following fields in the ApiOperation are eligible for filtering:

  • name - The ApiOperation resource name. Allowed comparison operators: =.
  • details.http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: =.
  • details.http_operation.method - The http operation method type. Allowed comparison operators: =.
  • details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: =.

  • create_time - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.

    Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

    Here are a few examples:

  • details.deprecated = True - The ApiOperation is deprecated.

  • details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • details.http_operation.method = GET OR details.http_operation.method = POST. - The http operation of the method of ApiOperation is GET or POST.

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListApiOperationsRequest.Builder setFilterBytes(ByteString value)

Optional. An expression that filters the list of ApiOperations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive.

The following fields in the ApiOperation are eligible for filtering:

  • name - The ApiOperation resource name. Allowed comparison operators: =.
  • details.http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: =.
  • details.http_operation.method - The http operation method type. Allowed comparison operators: =.
  • details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: =.

  • create_time - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.

    Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

    Here are a few examples:

  • details.deprecated = True - The ApiOperation is deprecated.

  • details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • details.http_operation.method = GET OR details.http_operation.method = POST. - The http operation of the method of ApiOperation is GET or POST.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListApiOperationsRequest.Builder setPageSize(int value)

Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListApiOperationsRequest.Builder setPageToken(String value)

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

When paginating, all other parameters (except page_size) provided to ListApiOperations must match the call that provided the page token.

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

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListApiOperationsRequest.Builder setPageTokenBytes(ByteString value)

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

When paginating, all other parameters (except page_size) provided to ListApiOperations must match the call that provided the page token.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListApiOperationsRequest.Builder setParent(String value)

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListApiOperationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListApiOperationsRequest.Builder setParentBytes(ByteString value)

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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