| <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="config_v1.html">Infrastructure Manager API</a> . <a href="config_v1.projects.html">projects</a> . <a href="config_v1.projects.locations.html">locations</a> . <a href="config_v1.projects.locations.deploymentGroups.html">deploymentGroups</a> . <a href="config_v1.projects.locations.deploymentGroups.revisions.html">revisions</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="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details about a DeploymentGroupRevision.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists DeploymentGroupRevisions in a given DeploymentGroup.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</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="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details about a DeploymentGroupRevision. |
| |
| Args: |
| name: string, Required. The name of the deployment group revision to retrieve. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}/revisions/{revision}'. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A DeploymentGroupRevision represents a snapshot of a DeploymentGroup at a given point in time, created when a DeploymentGroup is provisioned or deprovisioned. |
| "alternativeIds": [ # Output only. The alternative IDs of the deployment group revision. |
| "A String", |
| ], |
| "createTime": "A String", # Output only. Time when the deployment group revision was created. |
| "name": "A String", # Identifier. The name of the deployment group revision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}/revisions/{revision}'. |
| "snapshot": { # A DeploymentGroup is a collection of DeploymentUnits that in a DAG-like structure. # Output only. The snapshot of the deployment group at this revision. |
| "annotations": { # Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Output only. Time when the deployment group was created. |
| "deploymentUnits": [ # The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned. |
| { # A DeploymentUnit is a container for a deployment and its dependencies. An existing deployment can be provided directly in the unit, or the unit can act as a placeholder to define the DAG, with the deployment specs supplied in a `provisionDeploymentRequest`. |
| "dependencies": [ # Required. The IDs of the deployment units within the deployment group that this unit depends on. |
| "A String", |
| ], |
| "deployment": "A String", # Optional. The name of the deployment to be provisioned. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. |
| "id": "A String", # The id of the deployment unit. Must be unique within the deployment group. |
| }, |
| ], |
| "labels": { # Optional. User-defined metadata for the deployment group. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'. |
| "provisioningError": { # 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). # Output only. The error status of the deployment group provisioning or deprovisioning. |
| "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. |
| }, |
| "provisioningState": "A String", # Output only. The provisioning state of the deployment group. |
| "provisioningStateDescription": "A String", # Output only. Additional information regarding the current provisioning state. |
| "state": "A String", # Output only. Current state of the deployment group. |
| "stateDescription": "A String", # Output only. Additional information regarding the current state. |
| "updateTime": "A String", # Output only. Time when the deployment group was last updated. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists DeploymentGroupRevisions in a given DeploymentGroup. |
| |
| Args: |
| parent: string, Required. The parent, which owns this collection of deployment group revisions. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'. (required) |
| pageSize: integer, Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, a sensible default will be used by the server. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| pageToken: string, Optional. Token returned by previous call to 'ListDeploymentGroupRevisions' which specifies the position in the list from where to continue listing the deployment group revisions. All other parameters provided to `ListDeploymentGroupRevisions` must match the call that provided the page token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response message for the ListDeploymentGroupRevisions method. |
| "deploymentGroupRevisions": [ # The deployment group revisions from the specified collection. |
| { # A DeploymentGroupRevision represents a snapshot of a DeploymentGroup at a given point in time, created when a DeploymentGroup is provisioned or deprovisioned. |
| "alternativeIds": [ # Output only. The alternative IDs of the deployment group revision. |
| "A String", |
| ], |
| "createTime": "A String", # Output only. Time when the deployment group revision was created. |
| "name": "A String", # Identifier. The name of the deployment group revision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}/revisions/{revision}'. |
| "snapshot": { # A DeploymentGroup is a collection of DeploymentUnits that in a DAG-like structure. # Output only. The snapshot of the deployment group at this revision. |
| "annotations": { # Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. |
| "a_key": "A String", |
| }, |
| "createTime": "A String", # Output only. Time when the deployment group was created. |
| "deploymentUnits": [ # The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned. |
| { # A DeploymentUnit is a container for a deployment and its dependencies. An existing deployment can be provided directly in the unit, or the unit can act as a placeholder to define the DAG, with the deployment specs supplied in a `provisionDeploymentRequest`. |
| "dependencies": [ # Required. The IDs of the deployment units within the deployment group that this unit depends on. |
| "A String", |
| ], |
| "deployment": "A String", # Optional. The name of the deployment to be provisioned. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. |
| "id": "A String", # The id of the deployment unit. Must be unique within the deployment group. |
| }, |
| ], |
| "labels": { # Optional. User-defined metadata for the deployment group. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'. |
| "provisioningError": { # 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). # Output only. The error status of the deployment group provisioning or deprovisioning. |
| "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. |
| }, |
| "provisioningState": "A String", # Output only. The provisioning state of the deployment group. |
| "provisioningStateDescription": "A String", # Output only. Additional information regarding the current provisioning state. |
| "state": "A String", # Output only. Current state of the deployment group. |
| "stateDescription": "A String", # Output only. Additional information regarding the current state. |
| "updateTime": "A String", # Output only. Time when the deployment group was last updated. |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # Token to be supplied to the next ListDeploymentGroupRevisions request via `page_token` to obtain the next set of results. |
| "unreachable": [ # Unordered list. Locations that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</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> |
| |
| </body></html> |
