close()

Close httplib2 connections.

create(parent, body=None, requestId=None, workloadId=None, x__xgafv=None)

Creates a Workload in an Application.

Args:
  parent: string, Required. Fully qualified name of the Application to create Workload in. Expected format: `projects/{project}/locations/{location}/applications/{application}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Workload is an App Hub data model that contains a discovered workload, which represents a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality.
  "attributes": { # Consumer provided attributes. # Optional. Consumer provided attributes.
    "businessOwners": [ # Optional. Business team that ensures user needs are met and value is delivered
      { # Contact information of stakeholders.
        "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
        "email": "A String", # Required. Email address of the contacts.
      },
    ],
    "criticality": { # Criticality of the Application, Service, or Workload # Optional. User-defined criticality information.
      "type": "A String", # Required. Criticality Type.
    },
    "developerOwners": [ # Optional. Developer team that owns development and coding.
      { # Contact information of stakeholders.
        "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
        "email": "A String", # Required. Email address of the contacts.
      },
    ],
    "environment": { # Environment of the Application, Service, or Workload # Optional. User-defined environment information.
      "type": "A String", # Required. Environment Type.
    },
    "operatorOwners": [ # Optional. Operator team that ensures runtime and operations.
      { # Contact information of stakeholders.
        "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
        "email": "A String", # Required. Email address of the contacts.
      },
    ],
  },
  "createTime": "A String", # Output only. Create time.
  "description": "A String", # Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters.
  "discoveredWorkload": "A String", # Required. Immutable. The resource name of the original discovered workload.
  "displayName": "A String", # Optional. User-defined name for the Workload. Can have a maximum length of 63 characters.
  "name": "A String", # Identifier. The resource name of the Workload. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"`
  "state": "A String", # Output only. Workload state.
  "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
  "updateTime": "A String", # Output only. Update time.
  "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
    "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
    "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
    "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
  },
  "workloadReference": { # Reference of an underlying compute resource represented by the Workload. # Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
    "uri": "A String", # Output only. The underlying compute resource uri.
  },
}

  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  workloadId: string, Required. The Workload identifier. Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

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

Deletes a Workload from an Application.

Args:
name: string, Required. Fully qualified name of the Workload to delete from an Application. Expected format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`. (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets a Workload in an Application.

Args:
  name: string, Required. Fully qualified name of the Workload to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Workload is an App Hub data model that contains a discovered workload, which represents a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality.
  "attributes": { # Consumer provided attributes. # Optional. Consumer provided attributes.
    "businessOwners": [ # Optional. Business team that ensures user needs are met and value is delivered
      { # Contact information of stakeholders.
        "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
        "email": "A String", # Required. Email address of the contacts.
      },
    ],
    "criticality": { # Criticality of the Application, Service, or Workload # Optional. User-defined criticality information.
      "type": "A String", # Required. Criticality Type.
    },
    "developerOwners": [ # Optional. Developer team that owns development and coding.
      { # Contact information of stakeholders.
        "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
        "email": "A String", # Required. Email address of the contacts.
      },
    ],
    "environment": { # Environment of the Application, Service, or Workload # Optional. User-defined environment information.
      "type": "A String", # Required. Environment Type.
    },
    "operatorOwners": [ # Optional. Operator team that ensures runtime and operations.
      { # Contact information of stakeholders.
        "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
        "email": "A String", # Required. Email address of the contacts.
      },
    ],
  },
  "createTime": "A String", # Output only. Create time.
  "description": "A String", # Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters.
  "discoveredWorkload": "A String", # Required. Immutable. The resource name of the original discovered workload.
  "displayName": "A String", # Optional. User-defined name for the Workload. Can have a maximum length of 63 characters.
  "name": "A String", # Identifier. The resource name of the Workload. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"`
  "state": "A String", # Output only. Workload state.
  "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
  "updateTime": "A String", # Output only. Update time.
  "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
    "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
    "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
    "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
  },
  "workloadReference": { # Reference of an underlying compute resource represented by the Workload. # Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
    "uri": "A String", # Output only. The underlying compute resource uri.
  },
}

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

Lists Workloads in an Application.

Args:
  parent: string, Required. Fully qualified name of the parent Application to list Workloads for. Expected format: `projects/{project}/locations/{location}/applications/{application}`. (required)
  filter: string, Optional. Filtering results.
  orderBy: string, Optional. Hint for how to order the results.
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListWorkloads.
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
  "workloads": [ # List of Workloads.
    { # Workload is an App Hub data model that contains a discovered workload, which represents a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality.
      "attributes": { # Consumer provided attributes. # Optional. Consumer provided attributes.
        "businessOwners": [ # Optional. Business team that ensures user needs are met and value is delivered
          { # Contact information of stakeholders.
            "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
            "email": "A String", # Required. Email address of the contacts.
          },
        ],
        "criticality": { # Criticality of the Application, Service, or Workload # Optional. User-defined criticality information.
          "type": "A String", # Required. Criticality Type.
        },
        "developerOwners": [ # Optional. Developer team that owns development and coding.
          { # Contact information of stakeholders.
            "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
            "email": "A String", # Required. Email address of the contacts.
          },
        ],
        "environment": { # Environment of the Application, Service, or Workload # Optional. User-defined environment information.
          "type": "A String", # Required. Environment Type.
        },
        "operatorOwners": [ # Optional. Operator team that ensures runtime and operations.
          { # Contact information of stakeholders.
            "displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
            "email": "A String", # Required. Email address of the contacts.
          },
        ],
      },
      "createTime": "A String", # Output only. Create time.
      "description": "A String", # Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters.
      "discoveredWorkload": "A String", # Required. Immutable. The resource name of the original discovered workload.
      "displayName": "A String", # Optional. User-defined name for the Workload. Can have a maximum length of 63 characters.
      "name": "A String", # Identifier. The resource name of the Workload. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"`
      "state": "A String", # Output only. Workload state.
      "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
      "updateTime": "A String", # Output only. Update time.
      "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
        "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
        "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
        "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
      },
      "workloadReference": { # Reference of an underlying compute resource represented by the Workload. # Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
        "uri": "A String", # Output only. The underlying compute resource uri.
      },
    },
  ],
}

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, x__xgafv=None)

Updates a Workload in an Application.

Args:
name: string, Identifier. The resource name of the Workload. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"` (required)
body: object, The request body.
The object takes the form of:

{ # Workload is an App Hub data model that contains a discovered workload, which represents a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality.
"attributes": { # Consumer provided attributes. # Optional. Consumer provided attributes.
"businessOwners": [ # Optional. Business team that ensures user needs are met and value is delivered
{ # Contact information of stakeholders.
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"criticality": { # Criticality of the Application, Service, or Workload # Optional. User-defined criticality information.
"type": "A String", # Required. Criticality Type.
},
"developerOwners": [ # Optional. Developer team that owns development and coding.
{ # Contact information of stakeholders.
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"environment": { # Environment of the Application, Service, or Workload # Optional. User-defined environment information.
"type": "A String", # Required. Environment Type.
},
"operatorOwners": [ # Optional. Operator team that ensures runtime and operations.
{ # Contact information of stakeholders.
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters.
"discoveredWorkload": "A String", # Required. Immutable. The resource name of the original discovered workload.
"displayName": "A String", # Optional. User-defined name for the Workload. Can have a maximum length of 63 characters.
"name": "A String", # Identifier. The resource name of the Workload. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"`
"state": "A String", # Output only. Workload state.
"uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
"updateTime": "A String", # Output only. Update time.
"workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
"gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
"location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
"zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
},
"workloadReference": { # Reference of an underlying compute resource represented by the Workload. # Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
"uri": "A String", # Output only. The underlying compute resource uri.
},
}

requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

App Hub API . projects . locations . applications . workloads

Instance Methods

Method Details