Class AggregateFleetRequest (0.6.0) 

public final class AggregateFleetRequest extends GeneratedMessage implements AggregateFleetRequestOrBuilder

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

Protobuf type google.cloud.databasecenter.v1beta.AggregateFleetRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > AggregateFleetRequest

Static Fields

BASELINE_DATE_FIELD_NUMBER

public static final int BASELINE_DATE_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

GROUP_BY_FIELD_NUMBER

public static final int GROUP_BY_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 AggregateFleetRequest getDefaultInstance()
Returns
Type Description
AggregateFleetRequest

getDescriptor()

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

newBuilder()

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

newBuilder(AggregateFleetRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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.

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

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 AggregateFleetRequest.Builder newBuilderForType()
Returns
Type Description
AggregateFleetRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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