Class ListDeploymentGroupsRequest.Builder (0.68.0)

public static final class ListDeploymentGroupsRequest.Builder extends GeneratedMessage.Builder<ListDeploymentGroupsRequest.Builder> implements ListDeploymentGroupsRequestOrBuilder

The request message for the ListDeploymentGroups method.

Protobuf type google.cloud.config.v1.ListDeploymentGroupsRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListDeploymentGroupsRequest build()
Returns
Type Description
ListDeploymentGroupsRequest

buildPartial()

public ListDeploymentGroupsRequest buildPartial()
Returns
Type Description
ListDeploymentGroupsRequest

clear()

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

clearFilter()

public ListDeploymentGroupsRequest.Builder clearFilter()

Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups 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/deploymentGroups/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:

  • DeploymentGroups in CREATING state. state=CREATING

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

Returns
Type Description
ListDeploymentGroupsRequest.Builder

This builder for chaining.

clearOrderBy()

public ListDeploymentGroupsRequest.Builder clearOrderBy()

Optional. Field to use to sort the list.

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

Returns
Type Description
ListDeploymentGroupsRequest.Builder

This builder for chaining.

clearPageSize()

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

This builder for chaining.

clearPageToken()

public ListDeploymentGroupsRequest.Builder clearPageToken()

Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.

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

Returns
Type Description
ListDeploymentGroupsRequest.Builder

This builder for chaining.

clearParent()

public ListDeploymentGroupsRequest.Builder clearParent()

Required. The parent, which owns this collection of deployment groups. Format: 'projects/{project_id}/locations/{location}'.

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

Returns
Type Description
ListDeploymentGroupsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListDeploymentGroupsRequest getDefaultInstanceForType()
Returns
Type Description
ListDeploymentGroupsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups 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/deploymentGroups/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:

  • DeploymentGroups 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 DeploymentGroups that match the filter expression. A filter expression filters the deployment groups 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/deploymentGroups/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:

  • DeploymentGroups 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 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.

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 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.

string page_token = 3 [(.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 deployment groups. 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, which owns this collection of deployment groups. 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListDeploymentGroupsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListDeploymentGroupsRequest.Builder setFilter(String value)

Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups 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/deploymentGroups/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:

  • DeploymentGroups 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
ListDeploymentGroupsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListDeploymentGroupsRequest.Builder setFilterBytes(ByteString value)

Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups 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/deploymentGroups/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:

  • DeploymentGroups 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
ListDeploymentGroupsRequest.Builder

This builder for chaining.

setOrderBy(String value)

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

This builder for chaining.

setOrderByBytes(ByteString value)

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

This builder for chaining.

setPageSize(int value)

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

This builder for chaining.

setPageToken(String value)

public ListDeploymentGroupsRequest.Builder setPageToken(String value)

Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListDeploymentGroupsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDeploymentGroupsRequest.Builder setPageTokenBytes(ByteString value)

Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListDeploymentGroupsRequest.Builder

This builder for chaining.

setParent(String value)

public ListDeploymentGroupsRequest.Builder setParent(String value)

Required. The parent, which owns this collection of deployment groups. 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
ListDeploymentGroupsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListDeploymentGroupsRequest.Builder setParentBytes(ByteString value)

Required. The parent, which owns this collection of deployment groups. 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
ListDeploymentGroupsRequest.Builder

This builder for chaining.