Class ListDeploymentGroupsRequest (0.68.0)

public final class ListDeploymentGroupsRequest extends GeneratedMessage implements ListDeploymentGroupsRequestOrBuilder

The request message for the ListDeploymentGroups method.

Protobuf type google.cloud.config.v1.ListDeploymentGroupsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListDeploymentGroupsRequest getDefaultInstance()
Returns
Type Description
ListDeploymentGroupsRequest

getDescriptor()

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

newBuilder()

public static ListDeploymentGroupsRequest.Builder newBuilder()
Returns
Type Description
ListDeploymentGroupsRequest.Builder

newBuilder(ListDeploymentGroupsRequest prototype)

public static ListDeploymentGroupsRequest.Builder newBuilder(ListDeploymentGroupsRequest prototype)
Parameter
Name Description
prototype ListDeploymentGroupsRequest
Returns
Type Description
ListDeploymentGroupsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListDeploymentGroupsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDeploymentGroupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListDeploymentGroupsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListDeploymentGroupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListDeploymentGroupsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListDeploymentGroupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListDeploymentGroupsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDeploymentGroupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListDeploymentGroupsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDeploymentGroupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListDeploymentGroupsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListDeploymentGroupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDeploymentGroupsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListDeploymentGroupsRequest> parser()
Returns
Type Description
Parser<ListDeploymentGroupsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListDeploymentGroupsRequest getDefaultInstanceForType()
Returns
Type Description
ListDeploymentGroupsRequest

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.

getParserForType()

public Parser<ListDeploymentGroupsRequest> getParserForType()
Returns
Type Description
Parser<ListDeploymentGroupsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListDeploymentGroupsRequest.Builder newBuilderForType()
Returns
Type Description
ListDeploymentGroupsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListDeploymentGroupsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListDeploymentGroupsRequest.Builder
Overrides

toBuilder()

public ListDeploymentGroupsRequest.Builder toBuilder()
Returns
Type Description
ListDeploymentGroupsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException