| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="apphub_v1alpha.html">App Hub API</a> . <a href="apphub_v1alpha.projects.html">projects</a> . <a href="apphub_v1alpha.projects.locations.html">locations</a> . <a href="apphub_v1alpha.projects.locations.discoveredWorkloads.html">discoveredWorkloads</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#findUnregistered">findUnregistered(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Finds unregistered workloads in a host project and location.</p> | |
| <p class="toc_element"> | |
| <code><a href="#findUnregistered_next">findUnregistered_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets a Discovered Workload in a host project and location.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists Discovered Workloads that can be added to an Application in a host project and location.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#lookup">lookup(parent, uri=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists a Discovered Workload in a host project and location, with a given resource URI.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="findUnregistered">findUnregistered(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>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. | |
| "extendedMetadata": { # Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}` | |
| "a_key": { # Additional metadata for a Service or Workload. | |
| "metadataStruct": { # Output only. The metadata contents. | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| }, | |
| "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload. | |
| "type": "A String", # Output only. The functional type of a service or workload. | |
| }, | |
| "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources. | |
| "identity": { # The identity associated with a service or workload. # Output only. The identity associated with the workload. | |
| "principal": "A String", # Output only. The principal of the identity. Supported formats: * `sa://my-sa@PROJECT_ID.iam.gserviceaccount.com` for GCP Service Account * `principal://POOL_ID.global.PROJECT_NUMBER.workload.id.goog/ns/NAMESPACE_ID/sa/MANAGED_IDENTITY_ID` for Managed Workload Identity | |
| }, | |
| "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", | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="findUnregistered_next">findUnregistered_next(previous_request, previous_response)</code> | |
| <pre>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. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>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. | |
| "extendedMetadata": { # Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}` | |
| "a_key": { # Additional metadata for a Service or Workload. | |
| "metadataStruct": { # Output only. The metadata contents. | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| }, | |
| "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload. | |
| "type": "A String", # Output only. The functional type of a service or workload. | |
| }, | |
| "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources. | |
| "identity": { # The identity associated with a service or workload. # Output only. The identity associated with the workload. | |
| "principal": "A String", # Output only. The principal of the identity. Supported formats: * `sa://my-sa@PROJECT_ID.iam.gserviceaccount.com` for GCP Service Account * `principal://POOL_ID.global.PROJECT_NUMBER.workload.id.goog/ns/NAMESPACE_ID/sa/MANAGED_IDENTITY_ID` for Managed Workload Identity | |
| }, | |
| "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. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>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. | |
| "extendedMetadata": { # Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}` | |
| "a_key": { # Additional metadata for a Service or Workload. | |
| "metadataStruct": { # Output only. The metadata contents. | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| }, | |
| "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload. | |
| "type": "A String", # Output only. The functional type of a service or workload. | |
| }, | |
| "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources. | |
| "identity": { # The identity associated with a service or workload. # Output only. The identity associated with the workload. | |
| "principal": "A String", # Output only. The principal of the identity. Supported formats: * `sa://my-sa@PROJECT_ID.iam.gserviceaccount.com` for GCP Service Account * `principal://POOL_ID.global.PROJECT_NUMBER.workload.id.goog/ns/NAMESPACE_ID/sa/MANAGED_IDENTITY_ID` for Managed Workload Identity | |
| }, | |
| "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", | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>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. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="lookup">lookup(parent, uri=None, x__xgafv=None)</code> | |
| <pre>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. | |
| "extendedMetadata": { # Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}` | |
| "a_key": { # Additional metadata for a Service or Workload. | |
| "metadataStruct": { # Output only. The metadata contents. | |
| "a_key": "", # Properties of the object. | |
| }, | |
| }, | |
| }, | |
| "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload. | |
| "type": "A String", # Output only. The functional type of a service or workload. | |
| }, | |
| "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources. | |
| "identity": { # The identity associated with a service or workload. # Output only. The identity associated with the workload. | |
| "principal": "A String", # Output only. The principal of the identity. Supported formats: * `sa://my-sa@PROJECT_ID.iam.gserviceaccount.com` for GCP Service Account * `principal://POOL_ID.global.PROJECT_NUMBER.workload.id.goog/ns/NAMESPACE_ID/sa/MANAGED_IDENTITY_ID` for Managed Workload Identity | |
| }, | |
| "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. | |
| }, | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |