Commitment (Compute Engine API beta (Rev. 138) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.Commitment

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Commitment
extends com.google.api.client.json.GenericJson
```
Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Commitment()

Constructors
Constructor and Description
`Commitment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Commitment`	`clone()`
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.lang.String`	`getEndTimestamp()` [Output Only] Commitment end time in RFC3339 text format.
`java.math.BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`java.lang.String`	`getKind()` [Output Only] Type of the resource.
`java.lang.String`	`getName()` Name of the resource.
`java.lang.String`	`getPlan()` The plan for this commitment, which determines duration and discount rate.
`java.lang.String`	`getRegion()` [Output Only] URL of the region where this commitment may be used.
`java.util.List<Reservation>`	`getReservations()` List of reservations in this commitment.
`java.util.List<ResourceCommitment>`	`getResources()` A list of commitment amounts for particular resources.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`java.lang.String`	`getStartTimestamp()` [Output Only] Commitment start time in RFC3339 text format.
`java.lang.String`	`getStatus()` [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined).
`java.lang.String`	`getStatusMessage()` [Output Only] An optional, human-readable explanation of the status.
`java.lang.String`	`getType()` The type of commitment, which affects the discount rate and the eligible resources.
`Commitment`	`set(java.lang.String fieldName, java.lang.Object value)`
`Commitment`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Commitment`	`setDescription(java.lang.String description)` An optional description of this resource.
`Commitment`	`setEndTimestamp(java.lang.String endTimestamp)` [Output Only] Commitment end time in RFC3339 text format.
`Commitment`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`Commitment`	`setKind(java.lang.String kind)` [Output Only] Type of the resource.
`Commitment`	`setName(java.lang.String name)` Name of the resource.
`Commitment`	`setPlan(java.lang.String plan)` The plan for this commitment, which determines duration and discount rate.
`Commitment`	`setRegion(java.lang.String region)` [Output Only] URL of the region where this commitment may be used.
`Commitment`	`setReservations(java.util.List<Reservation> reservations)` List of reservations in this commitment.
`Commitment`	`setResources(java.util.List<ResourceCommitment> resources)` A list of commitment amounts for particular resources.
`Commitment`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined URL for the resource.
`Commitment`	`setStartTimestamp(java.lang.String startTimestamp)` [Output Only] Commitment start time in RFC3339 text format.
`Commitment`	`setStatus(java.lang.String status)` [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined).
`Commitment`	`setStatusMessage(java.lang.String statusMessage)` [Output Only] An optional, human-readable explanation of the status.
`Commitment`	`setType(java.lang.String type)` The type of commitment, which affects the discount rate and the eligible resources.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Commitment
```
public Commitment()
```
- Method Detail
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public Commitment setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Commitment setDescription(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getEndTimestamp
```
public java.lang.String getEndTimestamp()
```
    [Output Only] Commitment end time in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setEndTimestamp
```
public Commitment setEndTimestamp(java.lang.String endTimestamp)
```
    [Output Only] Commitment end time in RFC3339 text format.
    
    Parameters:
    
    endTimestamp - endTimestamp or null for none
  - getId
```
public java.math.BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public Commitment setId(java.math.BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    [Output Only] Type of the resource. Always compute#commitment for commitments.
    
    Returns:
    
    value or null for none
  - setKind
```
public Commitment setKind(java.lang.String kind)
```
    [Output Only] Type of the resource. Always compute#commitment for commitments.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public java.lang.String getName()
```
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    
    Returns:
    
    value or null for none
  - setName
```
public Commitment setName(java.lang.String name)
```
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    
    Parameters:
    
    name - name or null for none
  - getPlan
```
public java.lang.String getPlan()
```
    The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
    
    Returns:
    
    value or null for none
  - setPlan
```
public Commitment setPlan(java.lang.String plan)
```
    The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
    
    Parameters:
    
    plan - plan or null for none
  - getRegion
```
public java.lang.String getRegion()
```
    [Output Only] URL of the region where this commitment may be used.
    
    Returns:
    
    value or null for none
  - setRegion
```
public Commitment setRegion(java.lang.String region)
```
    [Output Only] URL of the region where this commitment may be used.
    
    Parameters:
    
    region - region or null for none
  - getReservations
```
public java.util.List<Reservation> getReservations()
```
    List of reservations in this commitment.
    
    Returns:
    
    value or null for none
  - setReservations
```
public Commitment setReservations(java.util.List<Reservation> reservations)
```
    List of reservations in this commitment.
    
    Parameters:
    
    reservations - reservations or null for none
  - getResources
```
public java.util.List<ResourceCommitment> getResources()
```
    A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
    
    Returns:
    
    value or null for none
  - setResources
```
public Commitment setResources(java.util.List<ResourceCommitment> resources)
```
    A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
    
    Parameters:
    
    resources - resources or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Commitment setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getStartTimestamp
```
public java.lang.String getStartTimestamp()
```
    [Output Only] Commitment start time in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setStartTimestamp
```
public Commitment setStartTimestamp(java.lang.String startTimestamp)
```
    [Output Only] Commitment start time in RFC3339 text format.
    
    Parameters:
    
    startTimestamp - startTimestamp or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Commitment setStatus(java.lang.String status)
```
    [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
    
    Parameters:
    
    status - status or null for none
  - getStatusMessage
```
public java.lang.String getStatusMessage()
```
    [Output Only] An optional, human-readable explanation of the status.
    
    Returns:
    
    value or null for none
  - setStatusMessage
```
public Commitment setStatusMessage(java.lang.String statusMessage)
```
    [Output Only] An optional, human-readable explanation of the status.
    
    Parameters:
    
    statusMessage - statusMessage or null for none
  - getType
```
public java.lang.String getType()
```
    The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
    
    Returns:
    
    value or null for none
  - setType
```
public Commitment setType(java.lang.String type)
```
    The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
    
    Parameters:
    
    type - type or null for none
  - set
```
public Commitment set(java.lang.String fieldName,
                      java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Commitment clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API beta (revision 138)

Class Commitment

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Commitment

Method Detail

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getEndTimestamp

setEndTimestamp

getId

setId

getKind

setKind

getName

setName

getPlan

setPlan

getRegion

setRegion

getReservations

setReservations

getResources

setResources

getSelfLink

setSelfLink

getStartTimestamp

setStartTimestamp

getStatus

setStatus

getStatusMessage

setStatusMessage

getType

setType

set

clone