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="replicapool_v1beta1.html">Replica Pool API</a> . <a href="replicapool_v1beta1.replicas.html">replicas</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(projectName, zone, poolName, replicaName, body)</a></code></p> 79 <p class="firstline">Deletes a replica from the pool.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(projectName, zone, poolName, replicaName)</a></code></p> 82 <p class="firstline">Gets information about a specific replica.</p> 83 <p class="toc_element"> 84 <code><a href="#list">list(projectName, zone, poolName, maxResults=None, pageToken=None)</a></code></p> 85 <p class="firstline">Lists all replicas in a pool.</p> 86 <p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88 <p class="firstline">Retrieves the next page of results.</p> 89 <p class="toc_element"> 90 <code><a href="#restart">restart(projectName, zone, poolName, replicaName)</a></code></p> 91 <p class="firstline">Restarts a replica in a pool.</p> 92 <h3>Method Details</h3> 93 <div class="method"> 94 <code class="details" id="delete">delete(projectName, zone, poolName, replicaName, body)</code> 95 <pre>Deletes a replica from the pool. 96 97 Args: 98 projectName: string, The project ID for this request. (required) 99 zone: string, The zone where the replica lives. (required) 100 poolName: string, The replica pool name for this request. (required) 101 replicaName: string, The name of the replica for this request. (required) 102 body: object, The request body. (required) 103 The object takes the form of: 104 105 { 106 "abandonInstance": True or False, # Whether the instance resource represented by this replica should be deleted or abandoned. If abandoned, the replica will be deleted but the virtual machine instance will remain. By default, this is set to false and the instance will be deleted along with the replica. 107 } 108 109 110 Returns: 111 An object of the form: 112 113 { # An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas. 114 "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica. 115 "vmStartTime": "A String", # [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned. 116 "state": "A String", # [Output Only] The state of the Replica. 117 "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents. 118 "details": "A String", # [Output Only] Human-readable details about the current state of the replica 119 "templateVersion": "A String", # [Output Only] The template used to build the replica. 120 }, 121 "name": "A String", # [Output Only] The name of the Replica object. 122 "selfLink": "A String", # [Output Only] The self-link of the Replica. 123 }</pre> 124 </div> 125 126 <div class="method"> 127 <code class="details" id="get">get(projectName, zone, poolName, replicaName)</code> 128 <pre>Gets information about a specific replica. 129 130 Args: 131 projectName: string, The project ID for this request. (required) 132 zone: string, The zone where the replica lives. (required) 133 poolName: string, The replica pool name for this request. (required) 134 replicaName: string, The name of the replica for this request. (required) 135 136 Returns: 137 An object of the form: 138 139 { # An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas. 140 "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica. 141 "vmStartTime": "A String", # [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned. 142 "state": "A String", # [Output Only] The state of the Replica. 143 "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents. 144 "details": "A String", # [Output Only] Human-readable details about the current state of the replica 145 "templateVersion": "A String", # [Output Only] The template used to build the replica. 146 }, 147 "name": "A String", # [Output Only] The name of the Replica object. 148 "selfLink": "A String", # [Output Only] The self-link of the Replica. 149 }</pre> 150 </div> 151 152 <div class="method"> 153 <code class="details" id="list">list(projectName, zone, poolName, maxResults=None, pageToken=None)</code> 154 <pre>Lists all replicas in a pool. 155 156 Args: 157 projectName: string, The project ID for this request. (required) 158 zone: string, The zone where the replica pool lives. (required) 159 poolName: string, The replica pool name for this request. (required) 160 maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50) 161 pageToken: string, Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request. 162 163 Returns: 164 An object of the form: 165 166 { 167 "nextPageToken": "A String", 168 "resources": [ 169 { # An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas. 170 "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica. 171 "vmStartTime": "A String", # [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned. 172 "state": "A String", # [Output Only] The state of the Replica. 173 "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents. 174 "details": "A String", # [Output Only] Human-readable details about the current state of the replica 175 "templateVersion": "A String", # [Output Only] The template used to build the replica. 176 }, 177 "name": "A String", # [Output Only] The name of the Replica object. 178 "selfLink": "A String", # [Output Only] The self-link of the Replica. 179 }, 180 ], 181 }</pre> 182 </div> 183 184 <div class="method"> 185 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 186 <pre>Retrieves the next page of results. 187 188 Args: 189 previous_request: The request for the previous page. (required) 190 previous_response: The response from the request for the previous page. (required) 191 192 Returns: 193 A request object that you can call 'execute()' on to request the next 194 page. Returns None if there are no more items in the collection. 195 </pre> 196 </div> 197 198 <div class="method"> 199 <code class="details" id="restart">restart(projectName, zone, poolName, replicaName)</code> 200 <pre>Restarts a replica in a pool. 201 202 Args: 203 projectName: string, The project ID for this request. (required) 204 zone: string, The zone where the replica lives. (required) 205 poolName: string, The replica pool name for this request. (required) 206 replicaName: string, The name of the replica for this request. (required) 207 208 Returns: 209 An object of the form: 210 211 { # An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas. 212 "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica. 213 "vmStartTime": "A String", # [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned. 214 "state": "A String", # [Output Only] The state of the Replica. 215 "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents. 216 "details": "A String", # [Output Only] Human-readable details about the current state of the replica 217 "templateVersion": "A String", # [Output Only] The template used to build the replica. 218 }, 219 "name": "A String", # [Output Only] The name of the Replica object. 220 "selfLink": "A String", # [Output Only] The self-link of the Replica. 221 }</pre> 222 </div> 223 224 </body></html>
