docs/dyn/replicapool_v1beta1.replicas.html - platform/external/python/google-api-python-client - Git at Google

 <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="replicapool_v1beta1.html">Replica Pool API</a> . <a href="replicapool_v1beta1.replicas.html">replicas</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(projectName, zone, poolName, replicaName, body)</a></code></p>
 <p class="firstline">Deletes a replica from the pool.</p>
 <p class="toc_element">
   <code><a href="#get">get(projectName, zone, poolName, replicaName)</a></code></p>
 <p class="firstline">Gets information about a specific replica.</p>
 <p class="toc_element">
   <code><a href="#list">list(projectName, zone, poolName, maxResults=None, pageToken=None)</a></code></p>
 <p class="firstline">Lists all replicas in a pool.</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="#restart">restart(projectName, zone, poolName, replicaName)</a></code></p>
 <p class="firstline">Restarts a replica in a pool.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="delete">delete(projectName, zone, poolName, replicaName, body)</code>
   <pre>Deletes a replica from the pool.

 Args:
   projectName: string, The project ID for this request. (required)
   zone: string, The zone where the replica lives. (required)
   poolName: string, The replica pool name for this request. (required)
   replicaName: string, The name of the replica for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:

 {
     "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.
   }


 Returns:
   An object of the form:

     { # 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.
     "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
       "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.
       "state": "A String", # [Output Only] The state of the Replica.
       "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
       "details": "A String", # [Output Only] Human-readable details about the current state of the replica
       "templateVersion": "A String", # [Output Only] The template used to build the replica.
     },
     "name": "A String", # [Output Only] The name of the Replica object.
     "selfLink": "A String", # [Output Only] The self-link of the Replica.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(projectName, zone, poolName, replicaName)</code>
   <pre>Gets information about a specific replica.

 Args:
   projectName: string, The project ID for this request. (required)
   zone: string, The zone where the replica lives. (required)
   poolName: string, The replica pool name for this request. (required)
   replicaName: string, The name of the replica for this request. (required)

 Returns:
   An object of the form:

     { # 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.
     "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
       "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.
       "state": "A String", # [Output Only] The state of the Replica.
       "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
       "details": "A String", # [Output Only] Human-readable details about the current state of the replica
       "templateVersion": "A String", # [Output Only] The template used to build the replica.
     },
     "name": "A String", # [Output Only] The name of the Replica object.
     "selfLink": "A String", # [Output Only] The self-link of the Replica.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(projectName, zone, poolName, maxResults=None, pageToken=None)</code>
   <pre>Lists all replicas in a pool.

 Args:
   projectName: string, The project ID for this request. (required)
   zone: string, The zone where the replica pool lives. (required)
   poolName: string, The replica pool name for this request. (required)
   maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
   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.

 Returns:
   An object of the form:

     {
     "nextPageToken": "A String",
     "resources": [
       { # 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.
         "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
           "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.
           "state": "A String", # [Output Only] The state of the Replica.
           "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
           "details": "A String", # [Output Only] Human-readable details about the current state of the replica
           "templateVersion": "A String", # [Output Only] The template used to build the replica.
         },
         "name": "A String", # [Output Only] The name of the Replica object.
         "selfLink": "A String", # [Output Only] The self-link of the Replica.
       },
     ],
   }</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="restart">restart(projectName, zone, poolName, replicaName)</code>
   <pre>Restarts a replica in a pool.

 Args:
   projectName: string, The project ID for this request. (required)
   zone: string, The zone where the replica lives. (required)
   poolName: string, The replica pool name for this request. (required)
   replicaName: string, The name of the replica for this request. (required)

 Returns:
   An object of the form:

     { # 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.
     "status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
       "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.
       "state": "A String", # [Output Only] The state of the Replica.
       "vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
       "details": "A String", # [Output Only] Human-readable details about the current state of the replica
       "templateVersion": "A String", # [Output Only] The template used to build the replica.
     },
     "name": "A String", # [Output Only] The name of the Replica object.
     "selfLink": "A String", # [Output Only] The self-link of the Replica.
   }</pre>
 </div>

 </body></html>
	<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="replicapool_v1beta1.html">Replica Pool API</a> . <a href="replicapool_v1beta1.replicas.html">replicas</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#delete">delete(projectName, zone, poolName, replicaName, body)</a></code></p>
	<p class="firstline">Deletes a replica from the pool.</p>
	<p class="toc_element">
	<code><a href="#get">get(projectName, zone, poolName, replicaName)</a></code></p>
	<p class="firstline">Gets information about a specific replica.</p>
	<p class="toc_element">
	<code><a href="#list">list(projectName, zone, poolName, maxResults=None, pageToken=None)</a></code></p>
	<p class="firstline">Lists all replicas in a pool.</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="#restart">restart(projectName, zone, poolName, replicaName)</a></code></p>
	<p class="firstline">Restarts a replica in a pool.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="delete">delete(projectName, zone, poolName, replicaName, body)</code>
	<pre>Deletes a replica from the pool.

	Args:
	projectName: string, The project ID for this request. (required)
	zone: string, The zone where the replica lives. (required)
	poolName: string, The replica pool name for this request. (required)
	replicaName: string, The name of the replica for this request. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{
	"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.
	}


	Returns:
	An object of the form:

	{ # 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.
	"status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
	"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.
	"state": "A String", # [Output Only] The state of the Replica.
	"vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
	"details": "A String", # [Output Only] Human-readable details about the current state of the replica
	"templateVersion": "A String", # [Output Only] The template used to build the replica.
	},
	"name": "A String", # [Output Only] The name of the Replica object.
	"selfLink": "A String", # [Output Only] The self-link of the Replica.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="get">get(projectName, zone, poolName, replicaName)</code>
	<pre>Gets information about a specific replica.

	Args:
	projectName: string, The project ID for this request. (required)
	zone: string, The zone where the replica lives. (required)
	poolName: string, The replica pool name for this request. (required)
	replicaName: string, The name of the replica for this request. (required)

	Returns:
	An object of the form:

	{ # 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.
	"status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
	"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.
	"state": "A String", # [Output Only] The state of the Replica.
	"vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
	"details": "A String", # [Output Only] Human-readable details about the current state of the replica
	"templateVersion": "A String", # [Output Only] The template used to build the replica.
	},
	"name": "A String", # [Output Only] The name of the Replica object.
	"selfLink": "A String", # [Output Only] The self-link of the Replica.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(projectName, zone, poolName, maxResults=None, pageToken=None)</code>
	<pre>Lists all replicas in a pool.

	Args:
	projectName: string, The project ID for this request. (required)
	zone: string, The zone where the replica pool lives. (required)
	poolName: string, The replica pool name for this request. (required)
	maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
	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.

	Returns:
	An object of the form:

	{
	"nextPageToken": "A String",
	"resources": [
	{ # 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.
	"status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
	"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.
	"state": "A String", # [Output Only] The state of the Replica.
	"vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
	"details": "A String", # [Output Only] Human-readable details about the current state of the replica
	"templateVersion": "A String", # [Output Only] The template used to build the replica.
	},
	"name": "A String", # [Output Only] The name of the Replica object.
	"selfLink": "A String", # [Output Only] The self-link of the Replica.
	},
	],
	}</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="restart">restart(projectName, zone, poolName, replicaName)</code>
	<pre>Restarts a replica in a pool.

	Args:
	projectName: string, The project ID for this request. (required)
	zone: string, The zone where the replica lives. (required)
	poolName: string, The replica pool name for this request. (required)
	replicaName: string, The name of the replica for this request. (required)

	Returns:
	An object of the form:

	{ # 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.
	"status": { # The current status of a Replica. # [Output Only] Last known status of the Replica.
	"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.
	"state": "A String", # [Output Only] The state of the Replica.
	"vmLink": "A String", # [Output Only] Link to the virtual machine that this Replica represents.
	"details": "A String", # [Output Only] Human-readable details about the current state of the replica
	"templateVersion": "A String", # [Output Only] The template used to build the replica.
	},
	"name": "A String", # [Output Only] The name of the Replica object.
	"selfLink": "A String", # [Output Only] The self-link of the Replica.
	}</pre>
	</div>

	</body></html>