com.google.api.services.apigee.v1

Class Apigee.Organizations.Instances

java.lang.Object

com.google.api.services.apigee.v1.Apigee.Organizations.Instances

Enclosing class:

Apigee.Organizations

public class Apigee.Organizations.Instances
extends Object

The "instances" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Apigee.Organizations.Instances.Attachments The "attachments" collection of methods.
class	Apigee.Organizations.Instances.Canaryevaluations The "canaryevaluations" collection of methods.
class	Apigee.Organizations.Instances.Create
class	Apigee.Organizations.Instances.Delete
class	Apigee.Organizations.Instances.Get
class	Apigee.Organizations.Instances.List
class	Apigee.Organizations.Instances.NatAddresses The "natAddresses" collection of methods.
class	Apigee.Organizations.Instances.Patch
class	Apigee.Organizations.Instances.ReportStatus

Constructor Summary

Constructors

Constructor and Description
Instances()

Method Summary

Modifier and Type	Method and Description
Apigee.Organizations.Instances.Attachments	attachments() An accessor for creating requests from the Attachments collection.
Apigee.Organizations.Instances.Canaryevaluations	canaryevaluations() An accessor for creating requests from the Canaryevaluations collection.
Apigee.Organizations.Instances.Create	create(String parent, GoogleCloudApigeeV1Instance content) Creates an Apigee runtime instance.
Apigee.Organizations.Instances.Delete	delete(String name) Deletes an Apigee runtime instance.
Apigee.Organizations.Instances.Get	get(String name) Gets the details for an Apigee runtime instance.
Apigee.Organizations.Instances.List	list(String parent) Lists all Apigee runtime instances for the organization.
Apigee.Organizations.Instances.NatAddresses	natAddresses() An accessor for creating requests from the NatAddresses collection.
Apigee.Organizations.Instances.Patch	patch(String name, GoogleCloudApigeeV1Instance content) Updates an Apigee runtime instance.
Apigee.Organizations.Instances.ReportStatus	reportStatus(String instance, GoogleCloudApigeeV1ReportInstanceStatusRequest content) Reports the latest status for a runtime instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Instances

public Instances()

Method Detail

create

public Apigee.Organizations.Instances.Create create(String parent,
                                                    GoogleCloudApigeeV1Instance content)
                                             throws IOException

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid. Create a request for the method "instances.create". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.

content - the GoogleCloudApigeeV1Instance

Returns:

the request

Throws:

IOException

delete

public Apigee.Organizations.Instances.Delete delete(String name)
                                             throws IOException

Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid. Create a request for the method "instances.delete". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.

Returns:

the request

Throws:

IOException

get

public Apigee.Organizations.Instances.Get get(String name)
                                       throws IOException

Gets the details for an Apigee runtime instance. **Note:** Not supported for Apigee hybrid. Create a request for the method "instances.get". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.

Returns:

the request

Throws:

IOException

list

public Apigee.Organizations.Instances.List list(String parent)
                                         throws IOException

Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid. Create a request for the method "instances.list". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the organization. Use the following structure in your request: `organizations/{org}`.

Returns:

the request

Throws:

IOException

patch

public Apigee.Organizations.Instances.Patch patch(String name,
                                                  GoogleCloudApigeeV1Instance content)
                                           throws IOException

Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. **Note:** Not supported for Apigee hybrid. Create a request for the method "instances.patch". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.

content - the GoogleCloudApigeeV1Instance

Returns:

the request

Throws:

IOException

reportStatus

public Apigee.Organizations.Instances.ReportStatus reportStatus(String instance,
                                                                GoogleCloudApigeeV1ReportInstanceStatusRequest content)
                                                         throws IOException

Reports the latest status for a runtime instance. Create a request for the method "instances.reportStatus". This request holds the parameters needed by the apigee server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

instance - The name of the instance reporting this status. For SaaS the request will be rejected if no instance exists under this name. Format is organizations/{org}/instances/{instance}

content - the GoogleCloudApigeeV1ReportInstanceStatusRequest

Returns:

the request

Throws:

IOException

attachments

public Apigee.Organizations.Instances.Attachments attachments()

An accessor for creating requests from the Attachments collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Attachments.List request = apigee.attachments().list(parameters ...)
 

Returns:

the resource collection

canaryevaluations

public Apigee.Organizations.Instances.Canaryevaluations canaryevaluations()

An accessor for creating requests from the Canaryevaluations collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.Canaryevaluations.List request = apigee.canaryevaluations().list(parameters ...)
 

Returns:

the resource collection

natAddresses

public Apigee.Organizations.Instances.NatAddresses natAddresses()

An accessor for creating requests from the NatAddresses collection.

The typical use is:

    Apigee apigee = new Apigee(...);
    Apigee.NatAddresses.List request = apigee.natAddresses().list(parameters ...)
 

Returns:

the resource collection