diff --git a/java/grpc-google-cloud-spanner-admin-instance-v1/0.1.13/apidocs/allclasses-frame.html b/java/grpc-google-cloud-spanner-admin-instance-v1/0.1.13/apidocs/allclasses-frame.html new file mode 100644 index 0000000000..c452056462 --- /dev/null +++ b/java/grpc-google-cloud-spanner-admin-instance-v1/0.1.13/apidocs/allclasses-frame.html @@ -0,0 +1,23 @@ + + + +
+ +public static final class InstanceAdminGrpc.InstanceAdminBlockingStub +extends io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminBlockingStub>+
+ Cloud Spanner Instance Admin API + The Cloud Spanner Instance Admin API can be used to create, delete, + modify and list instances. Instances are dedicated Cloud Spanner serving + and storage resources to be used by Cloud Spanner databases. + Each instance has a "configuration", which dictates where the + serving resources for the Cloud Spanner instance are located (e.g., + US-central, Europe). Configurations are created by Google based on + resource availability. + Cloud Spanner billing is based on the instances that exist and their + sizes. After an instance exists, there are no additional + per-database or per-operation charges for use of the instance + (though there may be additional network bandwidth charges). + Instances offer isolation: problems with databases in one instance + will not affect other instances. However, within an instance + databases can affect each other. For example, if one database in an + instance receives a lot of requests and consumes most of the + instance resources, fewer resources are available for other + databases in that instance, and their performance may suffer. +
| Modifier and Type | +Method and Description | +
|---|---|
protected InstanceAdminGrpc.InstanceAdminBlockingStub |
+build(io.grpc.Channel channel,
+ io.grpc.CallOptions callOptions) |
+
com.google.longrunning.Operation |
+createInstance(com.google.spanner.admin.instance.v1.CreateInstanceRequest request)
+
+ Creates an instance and begins preparing it to begin serving.
+ |
+
com.google.protobuf.Empty |
+deleteInstance(com.google.spanner.admin.instance.v1.DeleteInstanceRequest request)
+
+ Deletes an instance.
+ |
+
com.google.iam.v1.Policy |
+getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
+
+ Gets the access control policy for an instance resource.
+ |
+
com.google.spanner.admin.instance.v1.Instance |
+getInstance(com.google.spanner.admin.instance.v1.GetInstanceRequest request)
+
+ Gets information about a particular instance.
+ |
+
com.google.spanner.admin.instance.v1.InstanceConfig |
+getInstanceConfig(com.google.spanner.admin.instance.v1.GetInstanceConfigRequest request)
+
+ Gets information about a particular instance configuration.
+ |
+
com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse |
+listInstanceConfigs(com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest request)
+
+ Lists the supported instance configurations for a given project.
+ |
+
com.google.spanner.admin.instance.v1.ListInstancesResponse |
+listInstances(com.google.spanner.admin.instance.v1.ListInstancesRequest request)
+
+ Lists all instances in the given project.
+ |
+
com.google.iam.v1.Policy |
+setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
+
+ Sets the access control policy on an instance resource.
+ |
+
com.google.iam.v1.TestIamPermissionsResponse |
+testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
+
+ Returns permissions that the caller has on the specified instance resource.
+ |
+
com.google.longrunning.Operation |
+updateInstance(com.google.spanner.admin.instance.v1.UpdateInstanceRequest request)
+
+ Updates an instance, and begins allocating or releasing resources
+ as requested.
+ |
+
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReadyclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected InstanceAdminGrpc.InstanceAdminBlockingStub build(io.grpc.Channel channel, + io.grpc.CallOptions callOptions)+
build in class io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminBlockingStub>public com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse listInstanceConfigs(com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest request)+
+ Lists the supported instance configurations for a given project. +
public com.google.spanner.admin.instance.v1.InstanceConfig getInstanceConfig(com.google.spanner.admin.instance.v1.GetInstanceConfigRequest request)+
+ Gets information about a particular instance configuration. +
public com.google.spanner.admin.instance.v1.ListInstancesResponse listInstances(com.google.spanner.admin.instance.v1.ListInstancesRequest request)+
+ Lists all instances in the given project. +
public com.google.spanner.admin.instance.v1.Instance getInstance(com.google.spanner.admin.instance.v1.GetInstanceRequest request)+
+ Gets information about a particular instance. +
public com.google.longrunning.Operation createInstance(com.google.spanner.admin.instance.v1.CreateInstanceRequest request)+
+ Creates an instance and begins preparing it to begin serving. The + returned [long-running operation][google.longrunning.Operation] + can be used to track the progress of preparing the new + instance. The instance name is assigned by the caller. If the + named instance already exists, `CreateInstance` returns + `ALREADY_EXISTS`. + Immediately upon completion of this request: + * The instance is readable via the API, with all requested attributes + but no allocated resources. Its state is `CREATING`. + Until completion of the returned operation: + * Cancelling the operation renders the instance immediately unreadable + via the API. + * The instance can be deleted. + * All other attempts to modify the instance are rejected. + Upon completion of the returned operation: + * Billing for all successfully-allocated resources begins (some types + may have lower than the requested levels). + * Databases can be created in the instance. + * The instance's allocated resource levels are readable via the API. + * The instance's state becomes `READY`. + The returned [long-running operation][google.longrunning.Operation] will + have a name of the format `<instance_name>/operations/<operation_id>` and + can be used to track creation of the instance. The + [metadata][google.longrunning.Operation.metadata] field type is + [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. + The [response][google.longrunning.Operation.response] field type is + [Instance][google.spanner.admin.instance.v1.Instance], if successful. +
public com.google.longrunning.Operation updateInstance(com.google.spanner.admin.instance.v1.UpdateInstanceRequest request)+
+ Updates an instance, and begins allocating or releasing resources + as requested. The returned [long-running + operation][google.longrunning.Operation] can be used to track the + progress of updating the instance. If the named instance does not + exist, returns `NOT_FOUND`. + Immediately upon completion of this request: + * For resource types for which a decrease in the instance's allocation + has been requested, billing is based on the newly-requested level. + Until completion of the returned operation: + * Cancelling the operation sets its metadata's + [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins + restoring resources to their pre-request values. The operation + is guaranteed to succeed at undoing all resource changes, + after which point it terminates with a `CANCELLED` status. + * All other attempts to modify the instance are rejected. + * Reading the instance via the API continues to give the pre-request + resource levels. + Upon completion of the returned operation: + * Billing begins for all successfully-allocated resources (some types + may have lower than the requested levels). + * All newly-reserved resources are available for serving the instance's + tables. + * The instance's new resource levels are readable via the API. + The returned [long-running operation][google.longrunning.Operation] will + have a name of the format `<instance_name>/operations/<operation_id>` and + can be used to track the instance modification. The + [metadata][google.longrunning.Operation.metadata] field type is + [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. + The [response][google.longrunning.Operation.response] field type is + [Instance][google.spanner.admin.instance.v1.Instance], if successful. + Authorization requires `spanner.instances.update` permission on + resource [name][google.spanner.admin.instance.v1.Instance.name]. +
public com.google.protobuf.Empty deleteInstance(com.google.spanner.admin.instance.v1.DeleteInstanceRequest request)+
+ Deletes an instance. + Immediately upon completion of the request: + * Billing ceases for all of the instance's reserved resources. + Soon afterward: + * The instance and *all of its databases* immediately and + irrevocably disappear from the API. All data in the databases + is permanently deleted. +
public com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)+
+ Sets the access control policy on an instance resource. Replaces any + existing policy. + Authorization requires `spanner.instances.setIamPolicy` on + [resource][google.iam.v1.SetIamPolicyRequest.resource]. +
public com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)+
+ Gets the access control policy for an instance resource. Returns an empty + policy if an instance exists but does not have a policy set. + Authorization requires `spanner.instances.getIamPolicy` on + [resource][google.iam.v1.GetIamPolicyRequest.resource]. +
public com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)+
+ Returns permissions that the caller has on the specified instance resource. + Attempting this RPC on a non-existent Cloud Spanner instance resource will + result in a NOT_FOUND error if the user has `spanner.instances.list` + permission on the containing Google Cloud Project. Otherwise returns an + empty set of permissions. +
public static final class InstanceAdminGrpc.InstanceAdminFutureStub +extends io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminFutureStub>+
+ Cloud Spanner Instance Admin API + The Cloud Spanner Instance Admin API can be used to create, delete, + modify and list instances. Instances are dedicated Cloud Spanner serving + and storage resources to be used by Cloud Spanner databases. + Each instance has a "configuration", which dictates where the + serving resources for the Cloud Spanner instance are located (e.g., + US-central, Europe). Configurations are created by Google based on + resource availability. + Cloud Spanner billing is based on the instances that exist and their + sizes. After an instance exists, there are no additional + per-database or per-operation charges for use of the instance + (though there may be additional network bandwidth charges). + Instances offer isolation: problems with databases in one instance + will not affect other instances. However, within an instance + databases can affect each other. For example, if one database in an + instance receives a lot of requests and consumes most of the + instance resources, fewer resources are available for other + databases in that instance, and their performance may suffer. +
| Modifier and Type | +Method and Description | +
|---|---|
protected InstanceAdminGrpc.InstanceAdminFutureStub |
+build(io.grpc.Channel channel,
+ io.grpc.CallOptions callOptions) |
+
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> |
+createInstance(com.google.spanner.admin.instance.v1.CreateInstanceRequest request)
+
+ Creates an instance and begins preparing it to begin serving.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> |
+deleteInstance(com.google.spanner.admin.instance.v1.DeleteInstanceRequest request)
+
+ Deletes an instance.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> |
+getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
+
+ Gets the access control policy for an instance resource.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.spanner.admin.instance.v1.Instance> |
+getInstance(com.google.spanner.admin.instance.v1.GetInstanceRequest request)
+
+ Gets information about a particular instance.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.spanner.admin.instance.v1.InstanceConfig> |
+getInstanceConfig(com.google.spanner.admin.instance.v1.GetInstanceConfigRequest request)
+
+ Gets information about a particular instance configuration.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse> |
+listInstanceConfigs(com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest request)
+
+ Lists the supported instance configurations for a given project.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.spanner.admin.instance.v1.ListInstancesResponse> |
+listInstances(com.google.spanner.admin.instance.v1.ListInstancesRequest request)
+
+ Lists all instances in the given project.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> |
+setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
+
+ Sets the access control policy on an instance resource.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> |
+testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
+
+ Returns permissions that the caller has on the specified instance resource.
+ |
+
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> |
+updateInstance(com.google.spanner.admin.instance.v1.UpdateInstanceRequest request)
+
+ Updates an instance, and begins allocating or releasing resources
+ as requested.
+ |
+
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReadyclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected InstanceAdminGrpc.InstanceAdminFutureStub build(io.grpc.Channel channel, + io.grpc.CallOptions callOptions)+
build in class io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminFutureStub>public com.google.common.util.concurrent.ListenableFuture<com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse> listInstanceConfigs(com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest request)+
+ Lists the supported instance configurations for a given project. +
public com.google.common.util.concurrent.ListenableFuture<com.google.spanner.admin.instance.v1.InstanceConfig> getInstanceConfig(com.google.spanner.admin.instance.v1.GetInstanceConfigRequest request)+
+ Gets information about a particular instance configuration. +
public com.google.common.util.concurrent.ListenableFuture<com.google.spanner.admin.instance.v1.ListInstancesResponse> listInstances(com.google.spanner.admin.instance.v1.ListInstancesRequest request)+
+ Lists all instances in the given project. +
public com.google.common.util.concurrent.ListenableFuture<com.google.spanner.admin.instance.v1.Instance> getInstance(com.google.spanner.admin.instance.v1.GetInstanceRequest request)+
+ Gets information about a particular instance. +
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createInstance(com.google.spanner.admin.instance.v1.CreateInstanceRequest request)+
+ Creates an instance and begins preparing it to begin serving. The + returned [long-running operation][google.longrunning.Operation] + can be used to track the progress of preparing the new + instance. The instance name is assigned by the caller. If the + named instance already exists, `CreateInstance` returns + `ALREADY_EXISTS`. + Immediately upon completion of this request: + * The instance is readable via the API, with all requested attributes + but no allocated resources. Its state is `CREATING`. + Until completion of the returned operation: + * Cancelling the operation renders the instance immediately unreadable + via the API. + * The instance can be deleted. + * All other attempts to modify the instance are rejected. + Upon completion of the returned operation: + * Billing for all successfully-allocated resources begins (some types + may have lower than the requested levels). + * Databases can be created in the instance. + * The instance's allocated resource levels are readable via the API. + * The instance's state becomes `READY`. + The returned [long-running operation][google.longrunning.Operation] will + have a name of the format `<instance_name>/operations/<operation_id>` and + can be used to track creation of the instance. The + [metadata][google.longrunning.Operation.metadata] field type is + [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. + The [response][google.longrunning.Operation.response] field type is + [Instance][google.spanner.admin.instance.v1.Instance], if successful. +
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateInstance(com.google.spanner.admin.instance.v1.UpdateInstanceRequest request)+
+ Updates an instance, and begins allocating or releasing resources + as requested. The returned [long-running + operation][google.longrunning.Operation] can be used to track the + progress of updating the instance. If the named instance does not + exist, returns `NOT_FOUND`. + Immediately upon completion of this request: + * For resource types for which a decrease in the instance's allocation + has been requested, billing is based on the newly-requested level. + Until completion of the returned operation: + * Cancelling the operation sets its metadata's + [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins + restoring resources to their pre-request values. The operation + is guaranteed to succeed at undoing all resource changes, + after which point it terminates with a `CANCELLED` status. + * All other attempts to modify the instance are rejected. + * Reading the instance via the API continues to give the pre-request + resource levels. + Upon completion of the returned operation: + * Billing begins for all successfully-allocated resources (some types + may have lower than the requested levels). + * All newly-reserved resources are available for serving the instance's + tables. + * The instance's new resource levels are readable via the API. + The returned [long-running operation][google.longrunning.Operation] will + have a name of the format `<instance_name>/operations/<operation_id>` and + can be used to track the instance modification. The + [metadata][google.longrunning.Operation.metadata] field type is + [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. + The [response][google.longrunning.Operation.response] field type is + [Instance][google.spanner.admin.instance.v1.Instance], if successful. + Authorization requires `spanner.instances.update` permission on + resource [name][google.spanner.admin.instance.v1.Instance.name]. +
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteInstance(com.google.spanner.admin.instance.v1.DeleteInstanceRequest request)+
+ Deletes an instance. + Immediately upon completion of the request: + * Billing ceases for all of the instance's reserved resources. + Soon afterward: + * The instance and *all of its databases* immediately and + irrevocably disappear from the API. All data in the databases + is permanently deleted. +
public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)+
+ Sets the access control policy on an instance resource. Replaces any + existing policy. + Authorization requires `spanner.instances.setIamPolicy` on + [resource][google.iam.v1.SetIamPolicyRequest.resource]. +
public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)+
+ Gets the access control policy for an instance resource. Returns an empty + policy if an instance exists but does not have a policy set. + Authorization requires `spanner.instances.getIamPolicy` on + [resource][google.iam.v1.GetIamPolicyRequest.resource]. +
public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)+
+ Returns permissions that the caller has on the specified instance resource. + Attempting this RPC on a non-existent Cloud Spanner instance resource will + result in a NOT_FOUND error if the user has `spanner.instances.list` + permission on the containing Google Cloud Project. Otherwise returns an + empty set of permissions. +
public abstract static class InstanceAdminGrpc.InstanceAdminImplBase
+extends java.lang.Object
+implements io.grpc.BindableService
++ Cloud Spanner Instance Admin API + The Cloud Spanner Instance Admin API can be used to create, delete, + modify and list instances. Instances are dedicated Cloud Spanner serving + and storage resources to be used by Cloud Spanner databases. + Each instance has a "configuration", which dictates where the + serving resources for the Cloud Spanner instance are located (e.g., + US-central, Europe). Configurations are created by Google based on + resource availability. + Cloud Spanner billing is based on the instances that exist and their + sizes. After an instance exists, there are no additional + per-database or per-operation charges for use of the instance + (though there may be additional network bandwidth charges). + Instances offer isolation: problems with databases in one instance + will not affect other instances. However, within an instance + databases can affect each other. For example, if one database in an + instance receives a lot of requests and consumes most of the + instance resources, fewer resources are available for other + databases in that instance, and their performance may suffer. +
| Constructor and Description | +
|---|
InstanceAdminImplBase() |
+
| Modifier and Type | +Method and Description | +
|---|---|
io.grpc.ServerServiceDefinition |
+bindService() |
+
void |
+createInstance(com.google.spanner.admin.instance.v1.CreateInstanceRequest request,
+ io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
+
+ Creates an instance and begins preparing it to begin serving.
+ |
+
void |
+deleteInstance(com.google.spanner.admin.instance.v1.DeleteInstanceRequest request,
+ io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
+
+ Deletes an instance.
+ |
+
void |
+getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request,
+ io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
+
+ Gets the access control policy for an instance resource.
+ |
+
void |
+getInstance(com.google.spanner.admin.instance.v1.GetInstanceRequest request,
+ io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.Instance> responseObserver)
+
+ Gets information about a particular instance.
+ |
+
void |
+getInstanceConfig(com.google.spanner.admin.instance.v1.GetInstanceConfigRequest request,
+ io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.InstanceConfig> responseObserver)
+
+ Gets information about a particular instance configuration.
+ |
+
void |
+listInstanceConfigs(com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest request,
+ io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse> responseObserver)
+
+ Lists the supported instance configurations for a given project.
+ |
+
void |
+listInstances(com.google.spanner.admin.instance.v1.ListInstancesRequest request,
+ io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.ListInstancesResponse> responseObserver)
+
+ Lists all instances in the given project.
+ |
+
void |
+setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request,
+ io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
+
+ Sets the access control policy on an instance resource.
+ |
+
void |
+testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request,
+ io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)
+
+ Returns permissions that the caller has on the specified instance resource.
+ |
+
void |
+updateInstance(com.google.spanner.admin.instance.v1.UpdateInstanceRequest request,
+ io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
+
+ Updates an instance, and begins allocating or releasing resources
+ as requested.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void listInstanceConfigs(com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest request, + io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse> responseObserver)+
+ Lists the supported instance configurations for a given project. +
public void getInstanceConfig(com.google.spanner.admin.instance.v1.GetInstanceConfigRequest request, + io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.InstanceConfig> responseObserver)+
+ Gets information about a particular instance configuration. +
public void listInstances(com.google.spanner.admin.instance.v1.ListInstancesRequest request, + io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.ListInstancesResponse> responseObserver)+
+ Lists all instances in the given project. +
public void getInstance(com.google.spanner.admin.instance.v1.GetInstanceRequest request, + io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.Instance> responseObserver)+
+ Gets information about a particular instance. +
public void createInstance(com.google.spanner.admin.instance.v1.CreateInstanceRequest request, + io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)+
+ Creates an instance and begins preparing it to begin serving. The + returned [long-running operation][google.longrunning.Operation] + can be used to track the progress of preparing the new + instance. The instance name is assigned by the caller. If the + named instance already exists, `CreateInstance` returns + `ALREADY_EXISTS`. + Immediately upon completion of this request: + * The instance is readable via the API, with all requested attributes + but no allocated resources. Its state is `CREATING`. + Until completion of the returned operation: + * Cancelling the operation renders the instance immediately unreadable + via the API. + * The instance can be deleted. + * All other attempts to modify the instance are rejected. + Upon completion of the returned operation: + * Billing for all successfully-allocated resources begins (some types + may have lower than the requested levels). + * Databases can be created in the instance. + * The instance's allocated resource levels are readable via the API. + * The instance's state becomes `READY`. + The returned [long-running operation][google.longrunning.Operation] will + have a name of the format `<instance_name>/operations/<operation_id>` and + can be used to track creation of the instance. The + [metadata][google.longrunning.Operation.metadata] field type is + [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. + The [response][google.longrunning.Operation.response] field type is + [Instance][google.spanner.admin.instance.v1.Instance], if successful. +
public void updateInstance(com.google.spanner.admin.instance.v1.UpdateInstanceRequest request, + io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)+
+ Updates an instance, and begins allocating or releasing resources + as requested. The returned [long-running + operation][google.longrunning.Operation] can be used to track the + progress of updating the instance. If the named instance does not + exist, returns `NOT_FOUND`. + Immediately upon completion of this request: + * For resource types for which a decrease in the instance's allocation + has been requested, billing is based on the newly-requested level. + Until completion of the returned operation: + * Cancelling the operation sets its metadata's + [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins + restoring resources to their pre-request values. The operation + is guaranteed to succeed at undoing all resource changes, + after which point it terminates with a `CANCELLED` status. + * All other attempts to modify the instance are rejected. + * Reading the instance via the API continues to give the pre-request + resource levels. + Upon completion of the returned operation: + * Billing begins for all successfully-allocated resources (some types + may have lower than the requested levels). + * All newly-reserved resources are available for serving the instance's + tables. + * The instance's new resource levels are readable via the API. + The returned [long-running operation][google.longrunning.Operation] will + have a name of the format `<instance_name>/operations/<operation_id>` and + can be used to track the instance modification. The + [metadata][google.longrunning.Operation.metadata] field type is + [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. + The [response][google.longrunning.Operation.response] field type is + [Instance][google.spanner.admin.instance.v1.Instance], if successful. + Authorization requires `spanner.instances.update` permission on + resource [name][google.spanner.admin.instance.v1.Instance.name]. +
public void deleteInstance(com.google.spanner.admin.instance.v1.DeleteInstanceRequest request, + io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)+
+ Deletes an instance. + Immediately upon completion of the request: + * Billing ceases for all of the instance's reserved resources. + Soon afterward: + * The instance and *all of its databases* immediately and + irrevocably disappear from the API. All data in the databases + is permanently deleted. +
public void setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, + io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)+
+ Sets the access control policy on an instance resource. Replaces any + existing policy. + Authorization requires `spanner.instances.setIamPolicy` on + [resource][google.iam.v1.SetIamPolicyRequest.resource]. +
public void getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, + io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)+
+ Gets the access control policy for an instance resource. Returns an empty + policy if an instance exists but does not have a policy set. + Authorization requires `spanner.instances.getIamPolicy` on + [resource][google.iam.v1.GetIamPolicyRequest.resource]. +
public void testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, + io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)+
+ Returns permissions that the caller has on the specified instance resource. + Attempting this RPC on a non-existent Cloud Spanner instance resource will + result in a NOT_FOUND error if the user has `spanner.instances.list` + permission on the containing Google Cloud Project. Otherwise returns an + empty set of permissions. +
public final io.grpc.ServerServiceDefinition bindService()+
bindService in interface io.grpc.BindableServicepublic static final class InstanceAdminGrpc.InstanceAdminStub +extends io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminStub>+
+ Cloud Spanner Instance Admin API + The Cloud Spanner Instance Admin API can be used to create, delete, + modify and list instances. Instances are dedicated Cloud Spanner serving + and storage resources to be used by Cloud Spanner databases. + Each instance has a "configuration", which dictates where the + serving resources for the Cloud Spanner instance are located (e.g., + US-central, Europe). Configurations are created by Google based on + resource availability. + Cloud Spanner billing is based on the instances that exist and their + sizes. After an instance exists, there are no additional + per-database or per-operation charges for use of the instance + (though there may be additional network bandwidth charges). + Instances offer isolation: problems with databases in one instance + will not affect other instances. However, within an instance + databases can affect each other. For example, if one database in an + instance receives a lot of requests and consumes most of the + instance resources, fewer resources are available for other + databases in that instance, and their performance may suffer. +
| Modifier and Type | +Method and Description | +
|---|---|
protected InstanceAdminGrpc.InstanceAdminStub |
+build(io.grpc.Channel channel,
+ io.grpc.CallOptions callOptions) |
+
void |
+createInstance(com.google.spanner.admin.instance.v1.CreateInstanceRequest request,
+ io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
+
+ Creates an instance and begins preparing it to begin serving.
+ |
+
void |
+deleteInstance(com.google.spanner.admin.instance.v1.DeleteInstanceRequest request,
+ io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
+
+ Deletes an instance.
+ |
+
void |
+getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request,
+ io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
+
+ Gets the access control policy for an instance resource.
+ |
+
void |
+getInstance(com.google.spanner.admin.instance.v1.GetInstanceRequest request,
+ io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.Instance> responseObserver)
+
+ Gets information about a particular instance.
+ |
+
void |
+getInstanceConfig(com.google.spanner.admin.instance.v1.GetInstanceConfigRequest request,
+ io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.InstanceConfig> responseObserver)
+
+ Gets information about a particular instance configuration.
+ |
+
void |
+listInstanceConfigs(com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest request,
+ io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse> responseObserver)
+
+ Lists the supported instance configurations for a given project.
+ |
+
void |
+listInstances(com.google.spanner.admin.instance.v1.ListInstancesRequest request,
+ io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.ListInstancesResponse> responseObserver)
+
+ Lists all instances in the given project.
+ |
+
void |
+setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request,
+ io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
+
+ Sets the access control policy on an instance resource.
+ |
+
void |
+testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request,
+ io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)
+
+ Returns permissions that the caller has on the specified instance resource.
+ |
+
void |
+updateInstance(com.google.spanner.admin.instance.v1.UpdateInstanceRequest request,
+ io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
+
+ Updates an instance, and begins allocating or releasing resources
+ as requested.
+ |
+
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReadyclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected InstanceAdminGrpc.InstanceAdminStub build(io.grpc.Channel channel, + io.grpc.CallOptions callOptions)+
build in class io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminStub>public void listInstanceConfigs(com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest request, + io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse> responseObserver)+
+ Lists the supported instance configurations for a given project. +
public void getInstanceConfig(com.google.spanner.admin.instance.v1.GetInstanceConfigRequest request, + io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.InstanceConfig> responseObserver)+
+ Gets information about a particular instance configuration. +
public void listInstances(com.google.spanner.admin.instance.v1.ListInstancesRequest request, + io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.ListInstancesResponse> responseObserver)+
+ Lists all instances in the given project. +
public void getInstance(com.google.spanner.admin.instance.v1.GetInstanceRequest request, + io.grpc.stub.StreamObserver<com.google.spanner.admin.instance.v1.Instance> responseObserver)+
+ Gets information about a particular instance. +
public void createInstance(com.google.spanner.admin.instance.v1.CreateInstanceRequest request, + io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)+
+ Creates an instance and begins preparing it to begin serving. The + returned [long-running operation][google.longrunning.Operation] + can be used to track the progress of preparing the new + instance. The instance name is assigned by the caller. If the + named instance already exists, `CreateInstance` returns + `ALREADY_EXISTS`. + Immediately upon completion of this request: + * The instance is readable via the API, with all requested attributes + but no allocated resources. Its state is `CREATING`. + Until completion of the returned operation: + * Cancelling the operation renders the instance immediately unreadable + via the API. + * The instance can be deleted. + * All other attempts to modify the instance are rejected. + Upon completion of the returned operation: + * Billing for all successfully-allocated resources begins (some types + may have lower than the requested levels). + * Databases can be created in the instance. + * The instance's allocated resource levels are readable via the API. + * The instance's state becomes `READY`. + The returned [long-running operation][google.longrunning.Operation] will + have a name of the format `<instance_name>/operations/<operation_id>` and + can be used to track creation of the instance. The + [metadata][google.longrunning.Operation.metadata] field type is + [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. + The [response][google.longrunning.Operation.response] field type is + [Instance][google.spanner.admin.instance.v1.Instance], if successful. +
public void updateInstance(com.google.spanner.admin.instance.v1.UpdateInstanceRequest request, + io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)+
+ Updates an instance, and begins allocating or releasing resources + as requested. The returned [long-running + operation][google.longrunning.Operation] can be used to track the + progress of updating the instance. If the named instance does not + exist, returns `NOT_FOUND`. + Immediately upon completion of this request: + * For resource types for which a decrease in the instance's allocation + has been requested, billing is based on the newly-requested level. + Until completion of the returned operation: + * Cancelling the operation sets its metadata's + [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins + restoring resources to their pre-request values. The operation + is guaranteed to succeed at undoing all resource changes, + after which point it terminates with a `CANCELLED` status. + * All other attempts to modify the instance are rejected. + * Reading the instance via the API continues to give the pre-request + resource levels. + Upon completion of the returned operation: + * Billing begins for all successfully-allocated resources (some types + may have lower than the requested levels). + * All newly-reserved resources are available for serving the instance's + tables. + * The instance's new resource levels are readable via the API. + The returned [long-running operation][google.longrunning.Operation] will + have a name of the format `<instance_name>/operations/<operation_id>` and + can be used to track the instance modification. The + [metadata][google.longrunning.Operation.metadata] field type is + [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. + The [response][google.longrunning.Operation.response] field type is + [Instance][google.spanner.admin.instance.v1.Instance], if successful. + Authorization requires `spanner.instances.update` permission on + resource [name][google.spanner.admin.instance.v1.Instance.name]. +
public void deleteInstance(com.google.spanner.admin.instance.v1.DeleteInstanceRequest request, + io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)+
+ Deletes an instance. + Immediately upon completion of the request: + * Billing ceases for all of the instance's reserved resources. + Soon afterward: + * The instance and *all of its databases* immediately and + irrevocably disappear from the API. All data in the databases + is permanently deleted. +
public void setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, + io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)+
+ Sets the access control policy on an instance resource. Replaces any + existing policy. + Authorization requires `spanner.instances.setIamPolicy` on + [resource][google.iam.v1.SetIamPolicyRequest.resource]. +
public void getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, + io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)+
+ Gets the access control policy for an instance resource. Returns an empty + policy if an instance exists but does not have a policy set. + Authorization requires `spanner.instances.getIamPolicy` on + [resource][google.iam.v1.GetIamPolicyRequest.resource]. +
public void testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, + io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)+
+ Returns permissions that the caller has on the specified instance resource. + Attempting this RPC on a non-existent Cloud Spanner instance resource will + result in a NOT_FOUND error if the user has `spanner.instances.list` + permission on the containing Google Cloud Project. Otherwise returns an + empty set of permissions. +
@Generated(value="by gRPC proto compiler (version 1.2.0)",
+ comments="Source: google/spanner/admin/instance/v1/spanner_instance_admin.proto")
+public final class InstanceAdminGrpc
+extends java.lang.Object
++ Cloud Spanner Instance Admin API + The Cloud Spanner Instance Admin API can be used to create, delete, + modify and list instances. Instances are dedicated Cloud Spanner serving + and storage resources to be used by Cloud Spanner databases. + Each instance has a "configuration", which dictates where the + serving resources for the Cloud Spanner instance are located (e.g., + US-central, Europe). Configurations are created by Google based on + resource availability. + Cloud Spanner billing is based on the instances that exist and their + sizes. After an instance exists, there are no additional + per-database or per-operation charges for use of the instance + (though there may be additional network bandwidth charges). + Instances offer isolation: problems with databases in one instance + will not affect other instances. However, within an instance + databases can affect each other. For example, if one database in an + instance receives a lot of requests and consumes most of the + instance resources, fewer resources are available for other + databases in that instance, and their performance may suffer. +
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+InstanceAdminGrpc.InstanceAdminBlockingStub
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
static class |
+InstanceAdminGrpc.InstanceAdminFutureStub
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
static class |
+InstanceAdminGrpc.InstanceAdminImplBase
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
static class |
+InstanceAdminGrpc.InstanceAdminStub
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.CreateInstanceRequest,com.google.longrunning.Operation> |
+METHOD_CREATE_INSTANCE |
+
static io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.DeleteInstanceRequest,com.google.protobuf.Empty> |
+METHOD_DELETE_INSTANCE |
+
static io.grpc.MethodDescriptor<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
+METHOD_GET_IAM_POLICY |
+
static io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.GetInstanceRequest,com.google.spanner.admin.instance.v1.Instance> |
+METHOD_GET_INSTANCE |
+
static io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.GetInstanceConfigRequest,com.google.spanner.admin.instance.v1.InstanceConfig> |
+METHOD_GET_INSTANCE_CONFIG |
+
static io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest,com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse> |
+METHOD_LIST_INSTANCE_CONFIGS |
+
static io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.ListInstancesRequest,com.google.spanner.admin.instance.v1.ListInstancesResponse> |
+METHOD_LIST_INSTANCES |
+
static io.grpc.MethodDescriptor<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
+METHOD_SET_IAM_POLICY |
+
static io.grpc.MethodDescriptor<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
+METHOD_TEST_IAM_PERMISSIONS |
+
static io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.UpdateInstanceRequest,com.google.longrunning.Operation> |
+METHOD_UPDATE_INSTANCE |
+
static java.lang.String |
+SERVICE_NAME |
+
| Modifier and Type | +Method and Description | +
|---|---|
static io.grpc.ServiceDescriptor |
+getServiceDescriptor() |
+
static InstanceAdminGrpc.InstanceAdminBlockingStub |
+newBlockingStub(io.grpc.Channel channel)
+Creates a new blocking-style stub that supports unary and streaming output calls on the service
+ |
+
static InstanceAdminGrpc.InstanceAdminFutureStub |
+newFutureStub(io.grpc.Channel channel)
+Creates a new ListenableFuture-style stub that supports unary and streaming output calls on the service
+ |
+
static InstanceAdminGrpc.InstanceAdminStub |
+newStub(io.grpc.Channel channel)
+Creates a new async stub that supports all call types for the service
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final java.lang.String SERVICE_NAME+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.ListInstanceConfigsRequest,com.google.spanner.admin.instance.v1.ListInstanceConfigsResponse> METHOD_LIST_INSTANCE_CONFIGS+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.GetInstanceConfigRequest,com.google.spanner.admin.instance.v1.InstanceConfig> METHOD_GET_INSTANCE_CONFIG+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.ListInstancesRequest,com.google.spanner.admin.instance.v1.ListInstancesResponse> METHOD_LIST_INSTANCES+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.GetInstanceRequest,com.google.spanner.admin.instance.v1.Instance> METHOD_GET_INSTANCE+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.CreateInstanceRequest,com.google.longrunning.Operation> METHOD_CREATE_INSTANCE+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.UpdateInstanceRequest,com.google.longrunning.Operation> METHOD_UPDATE_INSTANCE+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.spanner.admin.instance.v1.DeleteInstanceRequest,com.google.protobuf.Empty> METHOD_DELETE_INSTANCE+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> METHOD_SET_IAM_POLICY+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> METHOD_GET_IAM_POLICY+
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1901") +public static final io.grpc.MethodDescriptor<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> METHOD_TEST_IAM_PERMISSIONS+
public static InstanceAdminGrpc.InstanceAdminStub newStub(io.grpc.Channel channel)+
public static InstanceAdminGrpc.InstanceAdminBlockingStub newBlockingStub(io.grpc.Channel channel)+
public static InstanceAdminGrpc.InstanceAdminFutureStub newFutureStub(io.grpc.Channel channel)+
public static io.grpc.ServiceDescriptor getServiceDescriptor()+
| Class | +Description | +
|---|---|
| InstanceAdminGrpc | +
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
| InstanceAdminGrpc.InstanceAdminBlockingStub | +
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
| InstanceAdminGrpc.InstanceAdminFutureStub | +
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
| InstanceAdminGrpc.InstanceAdminImplBase | +
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
| InstanceAdminGrpc.InstanceAdminStub | +
+
+ Cloud Spanner Instance Admin API
+ The Cloud Spanner Instance Admin API can be used to create, delete,
+ modify and list instances.
+ |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final java.lang.String |
+SERVICE_NAME |
+"google.spanner.admin.instance.v1.InstanceAdmin" |
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+