Class ListPreviewsRequest.Builder (0.30.0) 

public static final class ListPreviewsRequest.Builder extends GeneratedMessageV3.Builder<ListPreviewsRequest.Builder> implements ListPreviewsRequestOrBuilder

A request to list all previews for a given project and location.

Protobuf type google.cloud.config.v1.ListPreviewsRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListPreviewsRequest build()
Returns
Type Description
ListPreviewsRequest

buildPartial()

public ListPreviewsRequest buildPartial()
Returns
Type Description
ListPreviewsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListPreviewsRequest.Builder clearFilter()

Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = "projects/foo/locations/us-central1/deployments/bar

  • Filter by labels:

    • Resources that have a key called 'foo' labels.foo:*
    • Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar

  • Filter by state:

    • Deployments in CREATING state. state=CREATING

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

Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListPreviewsRequest.Builder clearOrderBy()

Optional. Field to use to sort the list.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

clearPageSize()

public ListPreviewsRequest.Builder clearPageSize()

Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.

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

Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

clearPageToken()

public ListPreviewsRequest.Builder clearPageToken()

Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

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

Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

clearParent()

public ListPreviewsRequest.Builder clearParent()

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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

Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListPreviewsRequest getDefaultInstanceForType()
Returns
Type Description
ListPreviewsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = "projects/foo/locations/us-central1/deployments/bar

  • Filter by labels:

    • Resources that have a key called 'foo' labels.foo:*
    • Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar

  • Filter by state:

    • Deployments in CREATING state. state=CREATING

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = "projects/foo/locations/us-central1/deployments/bar

  • Filter by labels:

    • Resources that have a key called 'foo' labels.foo:*
    • Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar

  • Filter by state:

    • Deployments in CREATING state. state=CREATING

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Field to use to sort the list.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Field to use to sort the list.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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 in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListPreviewsRequest.Builder setFilter(String value)

Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = "projects/foo/locations/us-central1/deployments/bar

  • Filter by labels:

    • Resources that have a key called 'foo' labels.foo:*
    • Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar

  • Filter by state:

    • Deployments in CREATING state. state=CREATING

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListPreviewsRequest.Builder setFilterBytes(ByteString value)

Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = "projects/foo/locations/us-central1/deployments/bar

  • Filter by labels:

    • Resources that have a key called 'foo' labels.foo:*
    • Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar

  • Filter by state:

    • Deployments in CREATING state. state=CREATING

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setOrderBy(String value)

public ListPreviewsRequest.Builder setOrderBy(String value)

Optional. Field to use to sort the list.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListPreviewsRequest.Builder setOrderByBytes(ByteString value)

Optional. Field to use to sort the list.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListPreviewsRequest.Builder setPageSize(int value)

Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.

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

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListPreviewsRequest.Builder setPageToken(String value)

Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

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

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListPreviewsRequest.Builder setPageTokenBytes(ByteString value)

Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

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

Parameter
Name Description
value ByteString

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

This builder for chaining.

setParent(String value)

public ListPreviewsRequest.Builder setParent(String value)

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListPreviewsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListPreviewsRequest.Builder setParentBytes(ByteString value)

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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