App Hub API . projects . locations . discoveredWorkloads

Instance Methods

close()

Close httplib2 connections.

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

Finds unregistered workloads in a host project and location.

findUnregistered_next()

Retrieves the next page of results.

get(name, x__xgafv=None)

Gets a Discovered Workload in a host project and location.

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

Lists Discovered Workloads that can be added to an Application in a host project and location.

list_next()

Retrieves the next page of results.

lookup(parent, uri=None, x__xgafv=None)

Lists a Discovered Workload in a host project and location, with a given resource URI.

Method Details

close()
Close httplib2 connections.
findUnregistered(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Finds unregistered workloads in a host project and location.

Args:
  parent: string, Required. Project and location to find unregistered Discovered Workloads on. Expected format: `projects/{project}/locations/{location}`. (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 FindUnregisteredWorkloads.
  "discoveredWorkloads": [ # List of Discovered Workloads.
    { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
      "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
      "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.
      },
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}
findUnregistered_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.
        
get(name, x__xgafv=None)
Gets a Discovered Workload in a host project and location.

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

Returns:
  An object of the form:

    { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
  "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
  "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 Discovered Workloads that can be added to an Application in a host project and location.

Args:
  parent: string, Required. Project and location to list Discovered Workloads on. Expected format: `projects/{project}/locations/{location}`. (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 ListDiscoveredWorkloads.
  "discoveredWorkloads": [ # List of Discovered Workloads.
    { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
      "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
      "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.
      },
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "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.
        
lookup(parent, uri=None, x__xgafv=None)
Lists a Discovered Workload in a host project and location, with a given resource URI.

Args:
  parent: string, Required. Host project ID and location to lookup Discovered Workload in. Expected format: `projects/{project}/locations/{location}`. (required)
  uri: string, Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for LookupDiscoveredWorkload.
  "discoveredWorkload": { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload. # Discovered Workload if exists, empty otherwise.
    "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
    "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.
    },
  },
}