Class AggregateFleetRequest.Builder (0.6.0)

public static final class AggregateFleetRequest.Builder extends GeneratedMessage.Builder<AggregateFleetRequest.Builder> implements AggregateFleetRequestOrBuilder

The request message to aggregate fleet which are grouped by a field.

Protobuf type google.cloud.databasecenter.v1beta.AggregateFleetRequest

Static Methods

getDescriptor()

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

Methods

build()

public AggregateFleetRequest build()
Returns
Type Description
AggregateFleetRequest

buildPartial()

public AggregateFleetRequest buildPartial()
Returns
Type Description
AggregateFleetRequest

clear()

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

clearBaselineDate()

public AggregateFleetRequest.Builder clearBaselineDate()

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

optional .google.type.Date baseline_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AggregateFleetRequest.Builder

clearFilter()

public AggregateFleetRequest.Builder clearFilter()

Optional. The expression to filter resources.

Supported fields are: full_resource_name, resource_type, container, product.type, product.engine, product.version, location, labels, issues, fields of availability_info, data_protection_info, 'resource_name', etc.

The expression is a list of zero or more restrictions combined via logical operators AND and OR. When AND and OR are both used in the expression, parentheses must be appropriately used to group the combinations.

Example: location="us-east1" Example: container="projects/123" OR container="projects/456" Example: (container="projects/123" OR container="projects/456") AND location="us-east1"

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

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

clearGroupBy()

public AggregateFleetRequest.Builder clearGroupBy()

Optional. A field that statistics are grouped by. Valid values are any combination of the following:

  • container
  • product.type
  • product.engine
  • product.version
  • location
  • sub_resource_type
  • management_type
  • tag.key
  • tag.value
  • tag.source
  • tag.inherited
  • label.key
  • label.value
  • label.source
  • has_maintenance_schedule
  • has_deny_maintenance_schedules Comma separated list.

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

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

clearOrderBy()

public AggregateFleetRequest.Builder clearOrderBy()

Optional. Valid values to order by are:

  • resource_groups_count
  • resources_count
  • and all fields supported by group_by The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields. For example: order_by = "resource_groups_count" sorts response in ascending order order_by = "resource_groups_count DESC" sorts response in descending order order_by = "product.type, product.version DESC, location" orders by type in ascending order, version in descending order and location in ascending order

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

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

clearPageSize()

public AggregateFleetRequest.Builder clearPageSize()

Optional. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

clearPageToken()

public AggregateFleetRequest.Builder clearPageToken()

Optional. A page token, received from a previous AggregateFleet call. Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.

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

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

clearParent()

public AggregateFleetRequest.Builder clearParent()

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
  • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
  • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

getBaselineDate()

public Date getBaselineDate()

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

optional .google.type.Date baseline_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Date

The baselineDate.

getBaselineDateBuilder()

public Date.Builder getBaselineDateBuilder()

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

optional .google.type.Date baseline_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Date.Builder

getBaselineDateOrBuilder()

public DateOrBuilder getBaselineDateOrBuilder()

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

optional .google.type.Date baseline_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DateOrBuilder

getDefaultInstanceForType()

public AggregateFleetRequest getDefaultInstanceForType()
Returns
Type Description
AggregateFleetRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. The expression to filter resources.

Supported fields are: full_resource_name, resource_type, container, product.type, product.engine, product.version, location, labels, issues, fields of availability_info, data_protection_info, 'resource_name', etc.

The expression is a list of zero or more restrictions combined via logical operators AND and OR. When AND and OR are both used in the expression, parentheses must be appropriately used to group the combinations.

Example: location="us-east1" Example: container="projects/123" OR container="projects/456" Example: (container="projects/123" OR container="projects/456") AND location="us-east1"

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. The expression to filter resources.

Supported fields are: full_resource_name, resource_type, container, product.type, product.engine, product.version, location, labels, issues, fields of availability_info, data_protection_info, 'resource_name', etc.

The expression is a list of zero or more restrictions combined via logical operators AND and OR. When AND and OR are both used in the expression, parentheses must be appropriately used to group the combinations.

Example: location="us-east1" Example: container="projects/123" OR container="projects/456" Example: (container="projects/123" OR container="projects/456") AND location="us-east1"

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

Returns
Type Description
ByteString

The bytes for filter.

getGroupBy()

public String getGroupBy()

Optional. A field that statistics are grouped by. Valid values are any combination of the following:

  • container
  • product.type
  • product.engine
  • product.version
  • location
  • sub_resource_type
  • management_type
  • tag.key
  • tag.value
  • tag.source
  • tag.inherited
  • label.key
  • label.value
  • label.source
  • has_maintenance_schedule
  • has_deny_maintenance_schedules Comma separated list.

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

Returns
Type Description
String

The groupBy.

getGroupByBytes()

public ByteString getGroupByBytes()

Optional. A field that statistics are grouped by. Valid values are any combination of the following:

  • container
  • product.type
  • product.engine
  • product.version
  • location
  • sub_resource_type
  • management_type
  • tag.key
  • tag.value
  • tag.source
  • tag.inherited
  • label.key
  • label.value
  • label.source
  • has_maintenance_schedule
  • has_deny_maintenance_schedules Comma separated list.

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

Returns
Type Description
ByteString

The bytes for groupBy.

getOrderBy()

public String getOrderBy()

Optional. Valid values to order by are:

  • resource_groups_count
  • resources_count
  • and all fields supported by group_by The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields. For example: order_by = "resource_groups_count" sorts response in ascending order order_by = "resource_groups_count DESC" sorts response in descending order order_by = "product.type, product.version DESC, location" orders by type in ascending order, version in descending order and location in ascending order

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Valid values to order by are:

  • resource_groups_count
  • resources_count
  • and all fields supported by group_by The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields. For example: order_by = "resource_groups_count" sorts response in ascending order order_by = "resource_groups_count DESC" sorts response in descending order order_by = "product.type, product.version DESC, location" orders by type in ascending order, version in descending order and location in ascending order

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

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous AggregateFleet call. Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous AggregateFleet call. Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
  • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
  • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
  • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
  • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

hasBaselineDate()

public boolean hasBaselineDate()

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

optional .google.type.Date baseline_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the baselineDate field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBaselineDate(Date value)

public AggregateFleetRequest.Builder mergeBaselineDate(Date value)

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

optional .google.type.Date baseline_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
AggregateFleetRequest.Builder

mergeFrom(AggregateFleetRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setBaselineDate(Date value)

public AggregateFleetRequest.Builder setBaselineDate(Date value)

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

optional .google.type.Date baseline_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
AggregateFleetRequest.Builder

setBaselineDate(Date.Builder builderForValue)

public AggregateFleetRequest.Builder setBaselineDate(Date.Builder builderForValue)

Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.

optional .google.type.Date baseline_date = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
AggregateFleetRequest.Builder

setFilter(String value)

public AggregateFleetRequest.Builder setFilter(String value)

Optional. The expression to filter resources.

Supported fields are: full_resource_name, resource_type, container, product.type, product.engine, product.version, location, labels, issues, fields of availability_info, data_protection_info, 'resource_name', etc.

The expression is a list of zero or more restrictions combined via logical operators AND and OR. When AND and OR are both used in the expression, parentheses must be appropriately used to group the combinations.

Example: location="us-east1" Example: container="projects/123" OR container="projects/456" Example: (container="projects/123" OR container="projects/456") AND location="us-east1"

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public AggregateFleetRequest.Builder setFilterBytes(ByteString value)

Optional. The expression to filter resources.

Supported fields are: full_resource_name, resource_type, container, product.type, product.engine, product.version, location, labels, issues, fields of availability_info, data_protection_info, 'resource_name', etc.

The expression is a list of zero or more restrictions combined via logical operators AND and OR. When AND and OR are both used in the expression, parentheses must be appropriately used to group the combinations.

Example: location="us-east1" Example: container="projects/123" OR container="projects/456" Example: (container="projects/123" OR container="projects/456") AND location="us-east1"

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setGroupBy(String value)

public AggregateFleetRequest.Builder setGroupBy(String value)

Optional. A field that statistics are grouped by. Valid values are any combination of the following:

  • container
  • product.type
  • product.engine
  • product.version
  • location
  • sub_resource_type
  • management_type
  • tag.key
  • tag.value
  • tag.source
  • tag.inherited
  • label.key
  • label.value
  • label.source
  • has_maintenance_schedule
  • has_deny_maintenance_schedules Comma separated list.

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

Parameter
Name Description
value String

The groupBy to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setGroupByBytes(ByteString value)

public AggregateFleetRequest.Builder setGroupByBytes(ByteString value)

Optional. A field that statistics are grouped by. Valid values are any combination of the following:

  • container
  • product.type
  • product.engine
  • product.version
  • location
  • sub_resource_type
  • management_type
  • tag.key
  • tag.value
  • tag.source
  • tag.inherited
  • label.key
  • label.value
  • label.source
  • has_maintenance_schedule
  • has_deny_maintenance_schedules Comma separated list.

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

Parameter
Name Description
value ByteString

The bytes for groupBy to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setOrderBy(String value)

public AggregateFleetRequest.Builder setOrderBy(String value)

Optional. Valid values to order by are:

  • resource_groups_count
  • resources_count
  • and all fields supported by group_by The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields. For example: order_by = "resource_groups_count" sorts response in ascending order order_by = "resource_groups_count DESC" sorts response in descending order order_by = "product.type, product.version DESC, location" orders by type in ascending order, version in descending order and location in ascending order

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

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public AggregateFleetRequest.Builder setOrderByBytes(ByteString value)

Optional. Valid values to order by are:

  • resource_groups_count
  • resources_count
  • and all fields supported by group_by The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields. For example: order_by = "resource_groups_count" sorts response in ascending order order_by = "resource_groups_count DESC" sorts response in descending order order_by = "product.type, product.version DESC, location" orders by type in ascending order, version in descending order and location in ascending order

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setPageSize(int value)

public AggregateFleetRequest.Builder setPageSize(int value)

Optional. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setPageToken(String value)

public AggregateFleetRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous AggregateFleet call. Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public AggregateFleetRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous AggregateFleet call. Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setParent(String value)

public AggregateFleetRequest.Builder setParent(String value)

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
  • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
  • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public AggregateFleetRequest.Builder setParentBytes(ByteString value)

Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
  • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
  • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
AggregateFleetRequest.Builder

This builder for chaining.