| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="osconfig_v1.html">Cloud OS Config API</a> . <a href="osconfig_v1.projects.html">projects</a> . <a href="osconfig_v1.projects.patchJobs.html">patchJobs</a> . <a href="osconfig_v1.projects.patchJobs.instanceDetails.html">instanceDetails</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Get a list of instance details for a given patch job.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| 85 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| 86 | <pre>Get a list of instance details for a given patch job. |
| 87 | |
| 88 | Args: |
| 89 | parent: string, Required. The parent for the instances are in the form of `projects/*/patchJobs/*`. (required) |
| 90 | pageToken: string, A pagination token returned from a previous call |
| 91 | that indicates where this listing should continue from. |
| 92 | pageSize: integer, The maximum number of instance details records to return. Default is 100. |
| 93 | filter: string, A filter expression that filters results listed in the response. This |
| 94 | field supports filtering results by instance zone, name, state, or |
| 95 | `failure_reason`. |
| 96 | x__xgafv: string, V1 error format. |
| 97 | Allowed values |
| 98 | 1 - v1 error format |
| 99 | 2 - v2 error format |
| 100 | |
| 101 | Returns: |
| 102 | An object of the form: |
| 103 | |
| 104 | { # A response message for listing the instances details for a patch job. |
| 105 | "nextPageToken": "A String", # A pagination token that can be used to get the next page of results. |
| 106 | "patchJobInstanceDetails": [ # A list of instance status. |
| 107 | { # Patch details for a VM instance. For more information about reviewing VM |
| 108 | # instance details, see |
| 109 | # [Listing all VM instance details for a specific patch |
| 110 | # job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details). |
| 111 | "instanceSystemId": "A String", # The unique identifier for the instance. This identifier is |
| 112 | # defined by the server. |
| 113 | "state": "A String", # Current state of instance patch. |
| 114 | "attemptCount": "A String", # The number of times the agent that the agent attempts to apply the patch. |
| 115 | "name": "A String", # The instance name in the form `projects/*/zones/*/instances/*` |
| 116 | "failureReason": "A String", # If the patch fails, this field provides the reason. |
| 117 | }, |
| 118 | ], |
| 119 | }</pre> |
| 120 | </div> |
| 121 | |
| 122 | <div class="method"> |
| 123 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 124 | <pre>Retrieves the next page of results. |
| 125 | |
| 126 | Args: |
| 127 | previous_request: The request for the previous page. (required) |
| 128 | previous_response: The response from the request for the previous page. (required) |
| 129 | |
| 130 | Returns: |
| 131 | A request object that you can call 'execute()' on to request the next |
| 132 | page. Returns None if there are no more items in the collection. |
| 133 | </pre> |
| 134 | </div> |
| 135 | |
| 136 | </body></html> |