Google Cloud Maintenance Api V1 Client - Class SummarizeMaintenancesRequest (0.3.0)

Reference documentation and code samples for the Google Cloud Maintenance Api V1 Client class SummarizeMaintenancesRequest.

Request message for SummarizeMaintenances custom method.

Generated from protobuf message google.cloud.maintenance.api.v1.SummarizeMaintenancesRequest

Namespace

Google \ Cloud \ Maintenance \ Api \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent of the resource maintenance. eg. projects/123/locations/*

↳ page_size
int

The maximum number of resource maintenances to send per page. The default page size is 20 and the maximum is 1000.

↳ page_token
string

The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.

↳ filter
string

Filter the list as specified in https://google.aip.dev/160 . Supported fields include: - state - resource.location - resource.resourceName - resource.type - maintenance.maintenanceName - maintenanceStartTime - maintenanceCompleteTime Examples: - state="SCHEDULED" - resource.location="us-central1-c" - resource.resourceName=~"*/instance-20241212-211259" - maintenanceStartTime>"2000-10-11T20:44:51Z" - state="SCHEDULED" OR resource.type="compute.googleapis.com/Instance" - maintenance.maitenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1" AND maintenanceCompleteTime>"2000-10-11T20:44:51Z"

↳ order_by
string

Order results as specified in https://google.aip.dev/132 .

getParent

Required. The parent of the resource maintenance.

eg. projects/123/locations/*

Returns
Type
Description
string

setParent

Required. The parent of the resource maintenance.

eg. projects/123/locations/*

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

The maximum number of resource maintenances to send per page. The default page size is 20 and the maximum is 1000.

Returns
Type
Description
int

setPageSize

The maximum number of resource maintenances to send per page. The default page size is 20 and the maximum is 1000.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.

Returns
Type
Description
string

setPageToken

The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

Filter the list as specified in https://google.aip.dev/160 .

Supported fields include:

  • state
  • resource.location
  • resource.resourceName
  • resource.type
  • maintenance.maintenanceName
  • maintenanceStartTime
  • maintenanceCompleteTime Examples:
  • state="SCHEDULED"
  • resource.location="us-central1-c"
  • resource.resourceName=~"*/instance-20241212-211259"
  • maintenanceStartTime>"2000-10-11T20:44:51Z"
  • state="SCHEDULED" OR resource.type="compute.googleapis.com/Instance"
  • maintenance.maitenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1" AND maintenanceCompleteTime>"2000-10-11T20:44:51Z"
Returns
Type
Description
string

setFilter

Filter the list as specified in https://google.aip.dev/160 .

Supported fields include:

  • state
  • resource.location
  • resource.resourceName
  • resource.type
  • maintenance.maintenanceName
  • maintenanceStartTime
  • maintenanceCompleteTime Examples:
  • state="SCHEDULED"
  • resource.location="us-central1-c"
  • resource.resourceName=~"*/instance-20241212-211259"
  • maintenanceStartTime>"2000-10-11T20:44:51Z"
  • state="SCHEDULED" OR resource.type="compute.googleapis.com/Instance"
  • maintenance.maitenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1" AND maintenanceCompleteTime>"2000-10-11T20:44:51Z"
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOrderBy

Order results as specified in https://google.aip.dev/132 .

Returns
Type
Description
string

setOrderBy

Order results as specified in https://google.aip.dev/132 .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameter
Name
Description
parent
string

Required. The parent of the resource maintenance. eg. projects/123/locations/* Please see MaintenanceClient::locationName() for help formatting this field.

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: