App Lifecycle Manager API . projects . locations . unitGroups

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, requestId=None, unitGroupId=None, validateOnly=None, x__xgafv=None)

Create a new unit group.

delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)

Delete a single unit group.

get(name, x__xgafv=None)

Retrieve a single unit group.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Retrieve a collection of unit groups.

list_next()

Retrieves the next page of results.

patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

Update a single unit group.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, requestId=None, unitGroupId=None, validateOnly=None, x__xgafv=None)
Create a new unit group.

Args:
  parent: string, Required. The parent of the unit group. (required)
  body: object, The request body.
    The object takes the form of:

{ # UnitGroup represents a set of Units to be used by a Tenant. In pooling scenarios, the UnitGroup may be created and provisioned before the Tenant is created.
  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitGroups/{unitGroup}"
  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
}

  requestId: string, An optional request ID to identify requests.
  unitGroupId: string, Required. The ID value for the new unit group.
  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # UnitGroup represents a set of Units to be used by a Tenant. In pooling scenarios, the UnitGroup may be created and provisioned before the Tenant is created.
  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitGroups/{unitGroup}"
  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
}
delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Delete a single unit group.

Args:
  name: string, Required. The resource name of the resource within a service. (required)
  etag: string, The etag known to the client for the expected state of the unit group.
  requestId: string, An optional request ID to identify requests.
  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Retrieve a single unit group.

Args:
  name: string, Required. The resource name of the resource within a service. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # UnitGroup represents a set of Units to be used by a Tenant. In pooling scenarios, the UnitGroup may be created and provisioned before the Tenant is created.
  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitGroups/{unitGroup}"
  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Retrieve a collection of unit groups.

Args:
  parent: string, Required. The parent of the unit group. (required)
  filter: string, Filter the list as specified in https://google.aip.dev/160.
  orderBy: string, Order results as specified in https://google.aip.dev/132.
  pageSize: integer, The maximum number of unit groups to send per page.
  pageToken: string, The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response structure for the ListUnitGroups method.
  "nextPageToken": "A String", # If present, the next page token can be provided to a subsequent ListUnitGroups call to list the next page. If empty, there are no more pages.
  "unitGroups": [ # The resulting unit groups.
    { # UnitGroup represents a set of Units to be used by a Tenant. In pooling scenarios, the UnitGroup may be created and provisioned before the Tenant is created.
      "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
        "a_key": "A String",
      },
      "createTime": "A String", # Output only. The timestamp when the resource was created.
      "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
      "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitGroups/{unitGroup}"
      "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
      "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
    },
  ],
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Update a single unit group.

Args:
  name: string, Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitGroups/{unitGroup}" (required)
  body: object, The request body.
    The object takes the form of:

{ # UnitGroup represents a set of Units to be used by a Tenant. In pooling scenarios, the UnitGroup may be created and provisioned before the Tenant is created.
  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitGroups/{unitGroup}"
  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
}

  requestId: string, An optional request ID to identify requests.
  updateMask: string, Field mask is used to specify the fields to be overwritten.
  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # UnitGroup represents a set of Units to be used by a Tenant. In pooling scenarios, the UnitGroup may be created and provisioned before the Tenant is created.
  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
    "a_key": "A String",
  },
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitGroups/{unitGroup}"
  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
}