Interface AggregateFleetRequestOrBuilder (0.6.0) 

public interface AggregateFleetRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBaselineDate()

public abstract 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.

getBaselineDateOrBuilder()

public abstract 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

getFilter()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.