Console
    Contact Us Start free

    REST Resource: projects.capacityPlans

    Resource: CapacityPlan

    A plan for additional capacity needed by a Google Cloud Platform project. This is synonymous with CapacityDemand, CapacityRequest, and CapacityDemandRequest.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "capacityDemandMetadata" 
 : 
 { 
 object (  DemandMetadata 
 
) 
 } 
 , 
 "serviceDemands" 
 : 
 [ 
 { 
 object (  ServiceDemand 
 
) 
 } 
 ] 
 , 
 "reporter" 
 : 
 { 
 object (  User 
 
) 
 } 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "title" 
 : 
 string 
 }
    Fields
    name

    string

    Identifier. The name of the capacity plan.

    Format: projects/{project}/capacityPlans/{capacityPlanId}
    capacityDemandMetadata

    object ( DemandMetadata )

    Optional. The metadata associated with a capacity demand.
    serviceDemands[]

    object ( ServiceDemand )

    Required. The capacity demand associated with a service.
    reporter

    object ( User )

    Output only. User who created the capacity plan.
    state

    enum ( State )

    Output only. State of the plan.
    createTime

    string ( Timestamp format)

    Output only. Timestamp when the plan was created.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. Timestamp when the plan was last updated.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    description

    string

    Optional. Description of the plan.
    title

    string

    Optional. Title of the plan.

    DemandMetadata

    The metadata associated with a capacity demand.

    JSON representation 
     { 
 "demandPreferences" 
 : 
 [ 
 { 
 object (  DemandPreference 
 
) 
 } 
 ] 
 }
    Fields
    demandPreferences[]

    object ( DemandPreference )

    Optional. The preferences associated with a capacity demand.

    DemandPreference

    Preference associated with a request, such as flexibility with alternate resource type.

    JSON representation 
     { 
 "preferenceId" 
 : 
 string 
 , 
 "value" 
 : 
 { 
 object (  Value 
 
) 
 } 
 }
    Fields
    preferenceId

    string

    Output only. The preference id.
    value

    object ( Value )

    Required. The value of demand preference.

    Value

    JSON representation 
     { 
 // Union field value 
can be only one of the following: 
 "int64Value" 
 : 
 string 
 , 
 "stringValue" 
 : 
 string 
 , 
 "doubleValue" 
 : 
 number 
 , 
 "boolValue" 
 : 
 boolean 
 // End of list of possible types for union field value 
. 
 }
    Fields

    Union field value .

    value can be only one of the following:

    int64Value

    string ( int64 format)

    stringValue

    string

    doubleValue

    number

    boolValue

    boolean

    ServiceDemand

    Capacity demand for a service.

    JSON representation 
     { 
 "service" 
 : 
 string 
 , 
 "demandMetadata" 
 : 
 { 
 object (  DemandMetadata 
 
) 
 } 
 , 
 "resourceDemands" 
 : 
 [ 
 { 
 object (  ResourceDemand 
 
) 
 } 
 ] 
 }
    Fields
    service

    string

    Required. Name of the service.
    demandMetadata

    object ( DemandMetadata )

    Optional. The metadata associated with a service demand.
    resourceDemands[]

    object ( ResourceDemand )

    Required. The demand associated with the resources.

    ResourceDemand

    Capacity demand for a resource.

    JSON representation 
     { 
 "id" 
 : 
 string 
 , 
 "resourceContainer" 
 : 
 { 
 object (  ResourceContainer 
 
) 
 } 
 , 
 "resourceId" 
 : 
 { 
 object (  ResourceIdentifier 
 
) 
 } 
 , 
 "locationId" 
 : 
 { 
 object (  LocationIdentifier 
 
) 
 } 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "reporter" 
 : 
 { 
 object (  User 
 
) 
 } 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "demandValues" 
 : 
 { 
 object (  DemandValues 
 
) 
 } 
 , 
 "demandMetadata" 
 : 
 { 
 object (  DemandMetadata 
 
) 
 } 
 , 
 "childResourceDemands" 
 : 
 [ 
 { 
 object (  ChildResourceDemand 
 
) 
 } 
 ] 
 }
    Fields
    id

    string

    Output only. Identifier of resource demand.
    resourceContainer

    object ( ResourceContainer )

    Required. The resource container associated with the demand.
    resourceId

    object ( ResourceIdentifier )

    Required. Identifier of resource.
    locationId

    object ( LocationIdentifier )

    Required. Identifier of location.
    state

    enum ( State )

    Output only. State of the resource demand.
    reporter

    object ( User )

    Output only. User who reported the demand.
    createTime

    string ( Timestamp format)

    Output only. Timestamp when the demand was created.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. Timestamp when the demand was last updated.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    demandValues

    object ( DemandValues )

    Required. The demand values associated with the resource.
    demandMetadata

    object ( DemandMetadata )

    Optional. The metadata associated with the demand.
    childResourceDemands[]

    object ( ChildResourceDemand )

    Optional. The child resource demands associated with the resource.

    ResourceContainer

    The resource container of Google Cloud Platform hierarchy such as a project.

    JSON representation 
     { 
 "type" 
 : 
 enum (  Type 
 
) 
 , 
 "id" 
 : 
 string 
 }
    Fields
    type

    enum ( Type )

    id

    string

    Required. Identifier of the resource container. For example, project number for project type.

    Type

    Enums
    TYPE_UNSPECIFIED
    PROJECT
    FOLDER
    ORG

    ResourceIdentifier

    The identifier for a Google Cloud Platform resource.

    JSON representation 
     { 
 "serviceName" 
 : 
 string 
 , 
 "resourceName" 
 : 
 string 
 , 
 "resourceAttributes" 
 : 
 [ 
 { 
 object (  ResourceAttribute 
 
) 
 } 
 ] 
 }
    Fields
    serviceName

    string

    resourceName

    string

    resourceAttributes[]

    object ( ResourceAttribute )

    ResourceAttribute

    An attribute of a Google Cloud Platform resource.

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 { 
 object (  ResourceValue 
 
) 
 } 
 }
    Fields
    key

    string

    value

    object ( ResourceValue )

    ResourceValue

    JSON representation 
     { 
 "unit" 
 : 
 enum (  Unit 
 
) 
 , 
 "value" 
 : 
 { 
 object (  Value 
 
) 
 } 
 }
    Fields
    unit

    enum ( Unit )

    value

    object ( Value )

    Unit

    Enums
    UNIT_UNSPECIFIED
    UNIT_COUNT
    KB Kilobytes (10^3 bytes)
    GB Gigabytes (10^9 bytes)
    TB Terabytes (10^12 bytes)
    MIB Mebibytes (2^20 bytes)
    GIB Gibibytes (2^30 bytes)
    TIB Tebibytes (2^40 bytes)
    QPS Queries per second
    MB Megabytes (10^6 bytes)
    PIB Pebibytes (2^50 bytes)
    TBPS

    Terabits (10^12 bits) per second
    GBPS_BITS
    GIB_BITS
    MBPS_BITS
    MBPS_BYTES
    TBPS_BITS
    TBPS_BYTES
    KOPS

    LocationIdentifier

    Identifier for a Google Cloud Platform location.

    JSON representation 
     { 
 "locationLevel" 
 : 
 enum (  LocationLevel 
 
) 
 , 
 "source" 
 : 
 string 
 , 
 "linkedLocations" 
 : 
 [ 
 { 
 object (  LinkedLocation 
 
) 
 } 
 ] 
 }
    Fields
    locationLevel

    enum ( LocationLevel )

    The location level such as a region.
    source

    string

    Required. Location where resource is sourced. For Cloud Storage, the alphabetically first location is the source.
    linkedLocations[]

    object ( LinkedLocation )

    Optional. Other linked locations.

    LocationLevel

    The level of the Google Cloud Platform location.

    Enums
    LOCATION_LEVEL_UNSPECIFIED Location level is unspecified.
    REGION Cloud region.
    ZONE Cloud zone.
    GLOBAL Globally.
    METRO A metro.
    DUAL_REGION Dual region pair.
    MULTI_REGION Multiple regions.

    LinkedLocation

    JSON representation 
     { 
 "locationLevel" 
 : 
 enum (  LocationLevel 
 
) 
 , 
 "location" 
 : 
 string 
 , 
 "label" 
 : 
 string 
 }
    Fields
    locationLevel

    enum ( LocationLevel )

    The location level such as a region.
    location

    string

    Required. The linked cloud location.
    label

    string

    State

    The state of a capacity demand.

    Enums
    STATE_UNSPECIFIED The state is unspecified.
    PENDING_REVIEW The demand is pending review.
    IN_REVIEW The demand is in review.
    APPROVED_PROVISIONAL The demand is provisionally approved.
    OBSOLETE The demand is obsolete.
    CANNOT_BE_FULFILLED The demand cannot be fulfilled.
    ON_HOLD_CONTACT_SALES The demand is on hold, contact sales.
    IN_FULFILLMENT The demand is in fulfillment.

    User

    A user who created or updated a capacity demand.

    JSON representation 
     { 
 "email" 
 : 
 string 
 }
    Fields
    email

    string

    Required. Email of the user.

    DemandValues

    The capacity demand values for a resource.

    JSON representation 
     { 
 "values" 
 : 
 [ 
 { 
 object (  DemandValue 
 
) 
 } 
 ] 
 }
    Fields
    values[]

    object ( DemandValue )

    Required. The demand values.

    DemandValue

    Capacity demand value for a single resource attribute such as CPU count, vertex AI peak QPM, etc.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "timeValues" 
 : 
 [ 
 { 
 object (  TimeValue 
 
) 
 } 
 ] 
 , 
 "unit" 
 : 
 enum (  Unit 
 
) 
 }
    Fields
    name

    string

    Required. The name of the demand value such as CPU count.
    timeValues[]

    object ( TimeValue )

    Required. The demand values at different time points.
    unit

    enum ( Unit )

    Required. Unit of measurement.

    TimeValue

    Capacity demand value for a single time point.

    JSON representation 
     { 
 "time" 
 : 
 string 
 , 
 "value" 
 : 
 number 
 }
    Fields
    time

    string ( Timestamp format)

    Required. The time point. If this demand value is non-temporal, set time to -1.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    value

    number

    Required. The demand value at the time point.

    ChildResourceDemand

    Capacity demand for a child resource such as shapes.

    JSON representation 
     { 
 "resourceId" 
 : 
 { 
 object (  ResourceIdentifier 
 
) 
 } 
 , 
 "demandValues" 
 : 
 { 
 object (  DemandValues 
 
) 
 } 
 , 
 "demandMetadata" 
 : 
 { 
 object (  DemandMetadata 
 
) 
 } 
 }
    Fields
    resourceId

    object ( ResourceIdentifier )

    Required. Identifier of resource.
    demandValues

    object ( DemandValues )

    Required. The demand values associated with the child resource.
    demandMetadata

    object ( DemandMetadata )

    Optional. The metadata associated with the child resource demand.

    Methods

    get

    		Returns information about the capacity plan.

    query

    		Returns a list of the capacity plans that are in the parent parameter and match your specified filters.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: