The interfaces provided are listed below, along with usage samples.
ApplicationsClient
Service Description: Manages App Engine applications.
Sample for ApplicationsClient:
try (ApplicationsClient applicationsClient = ApplicationsClient.create()) {
GetApplicationRequest request =
GetApplicationRequest.newBuilder().setName("name3373707").build();
Application response = applicationsClient.getApplication(request);
}
ServicesClient
Service Description: Manages services of an application.
Sample for ServicesClient:
try (ServicesClient servicesClient = ServicesClient.create()) {
GetServiceRequest request = GetServiceRequest.newBuilder().setName("name3373707").build();
Service response = servicesClient.getService(request);
}
VersionsClient
Service Description: Manages versions of a service.
Sample for VersionsClient:
try (VersionsClient versionsClient = VersionsClient.create()) {
GetVersionRequest request =
GetVersionRequest.newBuilder()
.setName("name3373707")
.setView(VersionView.forNumber(0))
.build();
Version response = versionsClient.getVersion(request);
}
InstancesClient
Service Description: Manages instances of a version.
Sample for InstancesClient:
try (InstancesClient instancesClient = InstancesClient.create()) {
GetInstanceRequest request = GetInstanceRequest.newBuilder().setName("name3373707").build();
Instance response = instancesClient.getInstance(request);
}
FirewallClient
Service Description: Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests.
Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.
Sample for FirewallClient:
try (FirewallClient firewallClient = FirewallClient.create()) {
BatchUpdateIngressRulesRequest request =
BatchUpdateIngressRulesRequest.newBuilder()
.setName("name3373707")
.addAllIngressRules(new ArrayList
AuthorizedDomainsClient
Service Description: Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
Sample for AuthorizedDomainsClient:
try (AuthorizedDomainsClient authorizedDomainsClient = AuthorizedDomainsClient.create()) {
ListAuthorizedDomainsRequest request =
ListAuthorizedDomainsRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (AuthorizedDomain element :
authorizedDomainsClient.listAuthorizedDomains(request).iterateAll()) {
// doThingsWith(element);
}
}
AuthorizedCertificatesClient
Service Description: Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
Sample for AuthorizedCertificatesClient:
try (AuthorizedCertificatesClient authorizedCertificatesClient =
AuthorizedCertificatesClient.create()) {
GetAuthorizedCertificateRequest request =
GetAuthorizedCertificateRequest.newBuilder()
.setName("name3373707")
.setView(AuthorizedCertificateView.forNumber(0))
.build();
AuthorizedCertificate response =
authorizedCertificatesClient.getAuthorizedCertificate(request);
}
DomainMappingsClient
Service Description: Manages domains serving an application.
Sample for DomainMappingsClient:
try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
GetDomainMappingRequest request =
GetDomainMappingRequest.newBuilder().setName("name3373707").build();
DomainMapping response = domainMappingsClient.getDomainMapping(request);
}
Classes
ApiConfigHandler
Google Cloud Endpoints configuration for API handlers.
Protobuf type google.appengine.v1.ApiConfigHandler
ApiConfigHandler.Builder
Google Cloud Endpoints configuration for API handlers.
Protobuf type google.appengine.v1.ApiConfigHandler
ApiEndpointHandler
Uses Google Cloud Endpoints to handle requests.
Protobuf type google.appengine.v1.ApiEndpointHandler
ApiEndpointHandler.Builder
Uses Google Cloud Endpoints to handle requests.
Protobuf type google.appengine.v1.ApiEndpointHandler
AppYamlProto
AppengineProto
Application
An Application resource contains the top-level configuration of an App Engine application.
Protobuf type google.appengine.v1.Application
Application.Builder
An Application resource contains the top-level configuration of an App Engine application.
Protobuf type google.appengine.v1.Application
Application.FeatureSettings
The feature specific settings to be used in the application. These define behaviors that are user configurable.
Protobuf type google.appengine.v1.Application.FeatureSettings
Application.FeatureSettings.Builder
The feature specific settings to be used in the application. These define behaviors that are user configurable.
Protobuf type google.appengine.v1.Application.FeatureSettings
Application.IdentityAwareProxy
Identity-Aware Proxy
Protobuf type google.appengine.v1.Application.IdentityAwareProxy
Application.IdentityAwareProxy.Builder
Identity-Aware Proxy
Protobuf type google.appengine.v1.Application.IdentityAwareProxy
ApplicationProto
ApplicationsClient
Service Description: Manages App Engine applications.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (ApplicationsClient applicationsClient = ApplicationsClient.create()) {
GetApplicationRequest request =
GetApplicationRequest.newBuilder().setName("name3373707").build();
Application response = applicationsClient.getApplication(request);
}
Note: close() needs to be called on the ApplicationsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ApplicationsSettings to create(). For example:
To customize credentials:
ApplicationsSettings applicationsSettings =
ApplicationsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ApplicationsClient applicationsClient = ApplicationsClient.create(applicationsSettings);
To customize the endpoint:
ApplicationsSettings applicationsSettings =
ApplicationsSettings.newBuilder().setEndpoint(myEndpoint).build();
ApplicationsClient applicationsClient = ApplicationsClient.create(applicationsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ApplicationsGrpc
Manages App Engine applications.
ApplicationsGrpc.ApplicationsBlockingStub
Manages App Engine applications.
ApplicationsGrpc.ApplicationsFutureStub
Manages App Engine applications.
ApplicationsGrpc.ApplicationsImplBase
Manages App Engine applications.
ApplicationsGrpc.ApplicationsStub
Manages App Engine applications.
ApplicationsSettings
Settings class to configure an instance of ApplicationsClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getApplication to 30 seconds:
ApplicationsSettings.Builder applicationsSettingsBuilder = ApplicationsSettings.newBuilder();
applicationsSettingsBuilder
.getApplicationSettings()
.setRetrySettings(
applicationsSettingsBuilder
.getApplicationSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ApplicationsSettings applicationsSettings = applicationsSettingsBuilder.build();
ApplicationsSettings.Builder
Builder for ApplicationsSettings.
AuditData
App Engine admin service audit log.
Protobuf type google.appengine.v1.AuditData
AuditData.Builder
App Engine admin service audit log.
Protobuf type google.appengine.v1.AuditData
AuditDataProto
AuthorizedCertificate
An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
Protobuf type google.appengine.v1.AuthorizedCertificate
AuthorizedCertificate.Builder
An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
Protobuf type google.appengine.v1.AuthorizedCertificate
AuthorizedCertificatesClient
Service Description: Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (AuthorizedCertificatesClient authorizedCertificatesClient =
AuthorizedCertificatesClient.create()) {
GetAuthorizedCertificateRequest request =
GetAuthorizedCertificateRequest.newBuilder()
.setName("name3373707")
.setView(AuthorizedCertificateView.forNumber(0))
.build();
AuthorizedCertificate response =
authorizedCertificatesClient.getAuthorizedCertificate(request);
}
Note: close() needs to be called on the AuthorizedCertificatesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AuthorizedCertificatesSettings to create(). For example:
To customize credentials:
AuthorizedCertificatesSettings authorizedCertificatesSettings =
AuthorizedCertificatesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AuthorizedCertificatesClient authorizedCertificatesClient =
AuthorizedCertificatesClient.create(authorizedCertificatesSettings);
To customize the endpoint:
AuthorizedCertificatesSettings authorizedCertificatesSettings =
AuthorizedCertificatesSettings.newBuilder().setEndpoint(myEndpoint).build();
AuthorizedCertificatesClient authorizedCertificatesClient =
AuthorizedCertificatesClient.create(authorizedCertificatesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
AuthorizedCertificatesClient.ListAuthorizedCertificatesFixedSizeCollection
AuthorizedCertificatesClient.ListAuthorizedCertificatesPage
AuthorizedCertificatesClient.ListAuthorizedCertificatesPagedResponse
AuthorizedCertificatesGrpc
Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
AuthorizedCertificatesGrpc.AuthorizedCertificatesBlockingStub
Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
AuthorizedCertificatesGrpc.AuthorizedCertificatesFutureStub
Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
AuthorizedCertificatesGrpc.AuthorizedCertificatesImplBase
Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
AuthorizedCertificatesGrpc.AuthorizedCertificatesStub
Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
AuthorizedCertificatesSettings
Settings class to configure an instance of AuthorizedCertificatesClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getAuthorizedCertificate to 30 seconds:
AuthorizedCertificatesSettings.Builder authorizedCertificatesSettingsBuilder =
AuthorizedCertificatesSettings.newBuilder();
authorizedCertificatesSettingsBuilder
.getAuthorizedCertificateSettings()
.setRetrySettings(
authorizedCertificatesSettingsBuilder
.getAuthorizedCertificateSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AuthorizedCertificatesSettings authorizedCertificatesSettings =
authorizedCertificatesSettingsBuilder.build();
AuthorizedCertificatesSettings.Builder
Builder for AuthorizedCertificatesSettings.
AuthorizedDomain
A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
Protobuf type google.appengine.v1.AuthorizedDomain
AuthorizedDomain.Builder
A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
Protobuf type google.appengine.v1.AuthorizedDomain
AuthorizedDomainsClient
Service Description: Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (AuthorizedDomainsClient authorizedDomainsClient = AuthorizedDomainsClient.create()) {
ListAuthorizedDomainsRequest request =
ListAuthorizedDomainsRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (AuthorizedDomain element :
authorizedDomainsClient.listAuthorizedDomains(request).iterateAll()) {
// doThingsWith(element);
}
}
Note: close() needs to be called on the AuthorizedDomainsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AuthorizedDomainsSettings to create(). For example:
To customize credentials:
AuthorizedDomainsSettings authorizedDomainsSettings =
AuthorizedDomainsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AuthorizedDomainsClient authorizedDomainsClient =
AuthorizedDomainsClient.create(authorizedDomainsSettings);
To customize the endpoint:
AuthorizedDomainsSettings authorizedDomainsSettings =
AuthorizedDomainsSettings.newBuilder().setEndpoint(myEndpoint).build();
AuthorizedDomainsClient authorizedDomainsClient =
AuthorizedDomainsClient.create(authorizedDomainsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
AuthorizedDomainsClient.ListAuthorizedDomainsFixedSizeCollection
AuthorizedDomainsClient.ListAuthorizedDomainsPage
AuthorizedDomainsClient.ListAuthorizedDomainsPagedResponse
AuthorizedDomainsGrpc
Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
AuthorizedDomainsGrpc.AuthorizedDomainsBlockingStub
Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
AuthorizedDomainsGrpc.AuthorizedDomainsFutureStub
Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
AuthorizedDomainsGrpc.AuthorizedDomainsImplBase
Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
AuthorizedDomainsGrpc.AuthorizedDomainsStub
Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.
AuthorizedDomainsSettings
Settings class to configure an instance of AuthorizedDomainsClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of listAuthorizedDomains to 30 seconds:
AuthorizedDomainsSettings.Builder authorizedDomainsSettingsBuilder =
AuthorizedDomainsSettings.newBuilder();
authorizedDomainsSettingsBuilder
.listAuthorizedDomainsSettings()
.setRetrySettings(
authorizedDomainsSettingsBuilder
.listAuthorizedDomainsSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AuthorizedDomainsSettings authorizedDomainsSettings = authorizedDomainsSettingsBuilder.build();
AuthorizedDomainsSettings.Builder
Builder for AuthorizedDomainsSettings.
AutomaticScaling
Automatic scaling is based on request rate, response latencies, and other application metrics.
Protobuf type google.appengine.v1.AutomaticScaling
AutomaticScaling.Builder
Automatic scaling is based on request rate, response latencies, and other application metrics.
Protobuf type google.appengine.v1.AutomaticScaling
BasicScaling
A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
Protobuf type google.appengine.v1.BasicScaling
BasicScaling.Builder
A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
Protobuf type google.appengine.v1.BasicScaling
BatchUpdateIngressRulesRequest
Request message for Firewall.BatchUpdateIngressRules.
Protobuf type google.appengine.v1.BatchUpdateIngressRulesRequest
BatchUpdateIngressRulesRequest.Builder
Request message for Firewall.BatchUpdateIngressRules.
Protobuf type google.appengine.v1.BatchUpdateIngressRulesRequest
BatchUpdateIngressRulesResponse
Response message for Firewall.UpdateAllIngressRules.
Protobuf type google.appengine.v1.BatchUpdateIngressRulesResponse
BatchUpdateIngressRulesResponse.Builder
Response message for Firewall.UpdateAllIngressRules.
Protobuf type google.appengine.v1.BatchUpdateIngressRulesResponse
CertificateProto
CertificateRawData
An SSL certificate obtained from a certificate authority.
Protobuf type google.appengine.v1.CertificateRawData
CertificateRawData.Builder
An SSL certificate obtained from a certificate authority.
Protobuf type google.appengine.v1.CertificateRawData
CloudBuildOptions
Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.
Protobuf type google.appengine.v1.CloudBuildOptions
CloudBuildOptions.Builder
Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.
Protobuf type google.appengine.v1.CloudBuildOptions
ContainerInfo
Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.
Protobuf type google.appengine.v1.ContainerInfo
ContainerInfo.Builder
Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.
Protobuf type google.appengine.v1.ContainerInfo
CpuUtilization
Target scaling by CPU usage.
Protobuf type google.appengine.v1.CpuUtilization
CpuUtilization.Builder
Target scaling by CPU usage.
Protobuf type google.appengine.v1.CpuUtilization
CreateApplicationRequest
Request message for Applications.CreateApplication.
Protobuf type google.appengine.v1.CreateApplicationRequest
CreateApplicationRequest.Builder
Request message for Applications.CreateApplication.
Protobuf type google.appengine.v1.CreateApplicationRequest
CreateAuthorizedCertificateRequest
Request message for AuthorizedCertificates.CreateAuthorizedCertificate.
Protobuf type google.appengine.v1.CreateAuthorizedCertificateRequest
CreateAuthorizedCertificateRequest.Builder
Request message for AuthorizedCertificates.CreateAuthorizedCertificate.
Protobuf type google.appengine.v1.CreateAuthorizedCertificateRequest
CreateDomainMappingRequest
Request message for DomainMappings.CreateDomainMapping.
Protobuf type google.appengine.v1.CreateDomainMappingRequest
CreateDomainMappingRequest.Builder
Request message for DomainMappings.CreateDomainMapping.
Protobuf type google.appengine.v1.CreateDomainMappingRequest
CreateIngressRuleRequest
Request message for Firewall.CreateIngressRule.
Protobuf type google.appengine.v1.CreateIngressRuleRequest
CreateIngressRuleRequest.Builder
Request message for Firewall.CreateIngressRule.
Protobuf type google.appengine.v1.CreateIngressRuleRequest
CreateVersionMetadataV1
Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.
Protobuf type google.appengine.v1.CreateVersionMetadataV1
CreateVersionMetadataV1.Builder
Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.
Protobuf type google.appengine.v1.CreateVersionMetadataV1
CreateVersionMethod
Detailed information about CreateVersion call.
Protobuf type google.appengine.v1.CreateVersionMethod
CreateVersionMethod.Builder
Detailed information about CreateVersion call.
Protobuf type google.appengine.v1.CreateVersionMethod
CreateVersionRequest
Request message for Versions.CreateVersion.
Protobuf type google.appengine.v1.CreateVersionRequest
CreateVersionRequest.Builder
Request message for Versions.CreateVersion.
Protobuf type google.appengine.v1.CreateVersionRequest
DebugInstanceRequest
Request message for Instances.DebugInstance.
Protobuf type google.appengine.v1.DebugInstanceRequest
DebugInstanceRequest.Builder
Request message for Instances.DebugInstance.
Protobuf type google.appengine.v1.DebugInstanceRequest
DeleteAuthorizedCertificateRequest
Request message for AuthorizedCertificates.DeleteAuthorizedCertificate.
Protobuf type google.appengine.v1.DeleteAuthorizedCertificateRequest
DeleteAuthorizedCertificateRequest.Builder
Request message for AuthorizedCertificates.DeleteAuthorizedCertificate.
Protobuf type google.appengine.v1.DeleteAuthorizedCertificateRequest
DeleteDomainMappingRequest
Request message for DomainMappings.DeleteDomainMapping.
Protobuf type google.appengine.v1.DeleteDomainMappingRequest
DeleteDomainMappingRequest.Builder
Request message for DomainMappings.DeleteDomainMapping.
Protobuf type google.appengine.v1.DeleteDomainMappingRequest
DeleteIngressRuleRequest
Request message for Firewall.DeleteIngressRule.
Protobuf type google.appengine.v1.DeleteIngressRuleRequest
DeleteIngressRuleRequest.Builder
Request message for Firewall.DeleteIngressRule.
Protobuf type google.appengine.v1.DeleteIngressRuleRequest
DeleteInstanceRequest
Request message for Instances.DeleteInstance.
Protobuf type google.appengine.v1.DeleteInstanceRequest
DeleteInstanceRequest.Builder
Request message for Instances.DeleteInstance.
Protobuf type google.appengine.v1.DeleteInstanceRequest
DeleteServiceRequest
Request message for Services.DeleteService.
Protobuf type google.appengine.v1.DeleteServiceRequest
DeleteServiceRequest.Builder
Request message for Services.DeleteService.
Protobuf type google.appengine.v1.DeleteServiceRequest
DeleteVersionRequest
Request message for Versions.DeleteVersion.
Protobuf type google.appengine.v1.DeleteVersionRequest
DeleteVersionRequest.Builder
Request message for Versions.DeleteVersion.
Protobuf type google.appengine.v1.DeleteVersionRequest
DeployProto
DeployedFilesProto
Deployment
Code and application artifacts used to deploy a version to App Engine.
Protobuf type google.appengine.v1.Deployment
Deployment.Builder
Code and application artifacts used to deploy a version to App Engine.
Protobuf type google.appengine.v1.Deployment
DiskUtilization
Target scaling by disk usage. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.DiskUtilization
DiskUtilization.Builder
Target scaling by disk usage. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.DiskUtilization
DomainMapping
A domain serving an App Engine application.
Protobuf type google.appengine.v1.DomainMapping
DomainMapping.Builder
A domain serving an App Engine application.
Protobuf type google.appengine.v1.DomainMapping
DomainMappingProto
DomainMappingsClient
Service Description: Manages domains serving an application.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (DomainMappingsClient domainMappingsClient = DomainMappingsClient.create()) {
GetDomainMappingRequest request =
GetDomainMappingRequest.newBuilder().setName("name3373707").build();
DomainMapping response = domainMappingsClient.getDomainMapping(request);
}
Note: close() needs to be called on the DomainMappingsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DomainMappingsSettings to create(). For example:
To customize credentials:
DomainMappingsSettings domainMappingsSettings =
DomainMappingsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DomainMappingsClient domainMappingsClient = DomainMappingsClient.create(domainMappingsSettings);
To customize the endpoint:
DomainMappingsSettings domainMappingsSettings =
DomainMappingsSettings.newBuilder().setEndpoint(myEndpoint).build();
DomainMappingsClient domainMappingsClient = DomainMappingsClient.create(domainMappingsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
DomainMappingsClient.ListDomainMappingsFixedSizeCollection
DomainMappingsClient.ListDomainMappingsPage
DomainMappingsClient.ListDomainMappingsPagedResponse
DomainMappingsGrpc
Manages domains serving an application.
DomainMappingsGrpc.DomainMappingsBlockingStub
Manages domains serving an application.
DomainMappingsGrpc.DomainMappingsFutureStub
Manages domains serving an application.
DomainMappingsGrpc.DomainMappingsImplBase
Manages domains serving an application.
DomainMappingsGrpc.DomainMappingsStub
Manages domains serving an application.
DomainMappingsSettings
Settings class to configure an instance of DomainMappingsClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getDomainMapping to 30 seconds:
DomainMappingsSettings.Builder domainMappingsSettingsBuilder =
DomainMappingsSettings.newBuilder();
domainMappingsSettingsBuilder
.getDomainMappingSettings()
.setRetrySettings(
domainMappingsSettingsBuilder
.getDomainMappingSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
DomainMappingsSettings domainMappingsSettings = domainMappingsSettingsBuilder.build();
DomainMappingsSettings.Builder
Builder for DomainMappingsSettings.
DomainProto
EndpointsApiService
Cloud Endpoints configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments. The fields here refer to the name and configuration ID of a "service" resource in the Service Management API.
Protobuf type google.appengine.v1.EndpointsApiService
EndpointsApiService.Builder
Cloud Endpoints configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments. The fields here refer to the name and configuration ID of a "service" resource in the Service Management API.
Protobuf type google.appengine.v1.EndpointsApiService
Entrypoint
The entrypoint for the application.
Protobuf type google.appengine.v1.Entrypoint
Entrypoint.Builder
The entrypoint for the application.
Protobuf type google.appengine.v1.Entrypoint
ErrorHandler
Custom static error page to be served when an error occurs.
Protobuf type google.appengine.v1.ErrorHandler
ErrorHandler.Builder
Custom static error page to be served when an error occurs.
Protobuf type google.appengine.v1.ErrorHandler
FileInfo
Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
Protobuf type google.appengine.v1.FileInfo
FileInfo.Builder
Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
Protobuf type google.appengine.v1.FileInfo
FirewallClient
Service Description: Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests.
Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (FirewallClient firewallClient = FirewallClient.create()) {
BatchUpdateIngressRulesRequest request =
BatchUpdateIngressRulesRequest.newBuilder()
.setName("name3373707")
.addAllIngressRules(new ArrayList
Note: close() needs to be called on the FirewallClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of FirewallSettings to create(). For example:
To customize credentials:
FirewallSettings firewallSettings =
FirewallSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
FirewallClient firewallClient = FirewallClient.create(firewallSettings);
To customize the endpoint:
FirewallSettings firewallSettings =
FirewallSettings.newBuilder().setEndpoint(myEndpoint).build();
FirewallClient firewallClient = FirewallClient.create(firewallSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
FirewallClient.ListIngressRulesFixedSizeCollection
FirewallClient.ListIngressRulesPage
FirewallClient.ListIngressRulesPagedResponse
FirewallGrpc
Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.
FirewallGrpc.FirewallBlockingStub
Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.
FirewallGrpc.FirewallFutureStub
Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.
FirewallGrpc.FirewallImplBase
Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.
FirewallGrpc.FirewallStub
Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.
FirewallSettings
Settings class to configure an instance of FirewallClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of batchUpdateIngressRules to 30 seconds:
FirewallSettings.Builder firewallSettingsBuilder = FirewallSettings.newBuilder();
firewallSettingsBuilder
.batchUpdateIngressRulesSettings()
.setRetrySettings(
firewallSettingsBuilder
.batchUpdateIngressRulesSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
FirewallSettings firewallSettings = firewallSettingsBuilder.build();
FirewallSettings.Builder
Builder for FirewallSettings.
GetApplicationRequest
Request message for Applications.GetApplication.
Protobuf type google.appengine.v1.GetApplicationRequest
GetApplicationRequest.Builder
Request message for Applications.GetApplication.
Protobuf type google.appengine.v1.GetApplicationRequest
GetAuthorizedCertificateRequest
Request message for AuthorizedCertificates.GetAuthorizedCertificate.
Protobuf type google.appengine.v1.GetAuthorizedCertificateRequest
GetAuthorizedCertificateRequest.Builder
Request message for AuthorizedCertificates.GetAuthorizedCertificate.
Protobuf type google.appengine.v1.GetAuthorizedCertificateRequest
GetDomainMappingRequest
Request message for DomainMappings.GetDomainMapping.
Protobuf type google.appengine.v1.GetDomainMappingRequest
GetDomainMappingRequest.Builder
Request message for DomainMappings.GetDomainMapping.
Protobuf type google.appengine.v1.GetDomainMappingRequest
GetIngressRuleRequest
Request message for Firewall.GetIngressRule.
Protobuf type google.appengine.v1.GetIngressRuleRequest
GetIngressRuleRequest.Builder
Request message for Firewall.GetIngressRule.
Protobuf type google.appengine.v1.GetIngressRuleRequest
GetInstanceRequest
Request message for Instances.GetInstance.
Protobuf type google.appengine.v1.GetInstanceRequest
GetInstanceRequest.Builder
Request message for Instances.GetInstance.
Protobuf type google.appengine.v1.GetInstanceRequest
GetServiceRequest
Request message for Services.GetService.
Protobuf type google.appengine.v1.GetServiceRequest
GetServiceRequest.Builder
Request message for Services.GetService.
Protobuf type google.appengine.v1.GetServiceRequest
GetVersionRequest
Request message for Versions.GetVersion.
Protobuf type google.appengine.v1.GetVersionRequest
GetVersionRequest.Builder
Request message for Versions.GetVersion.
Protobuf type google.appengine.v1.GetVersionRequest
HealthCheck
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
Protobuf type google.appengine.v1.HealthCheck
HealthCheck.Builder
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
Protobuf type google.appengine.v1.HealthCheck
Instance
An Instance resource is the computing unit that App Engine uses to automatically scale an application.
Protobuf type google.appengine.v1.Instance
Instance.Builder
An Instance resource is the computing unit that App Engine uses to automatically scale an application.
Protobuf type google.appengine.v1.Instance
Instance.Liveness
Wrapper for LivenessState enum.
Protobuf type google.appengine.v1.Instance.Liveness
Instance.Liveness.Builder
Wrapper for LivenessState enum.
Protobuf type google.appengine.v1.Instance.Liveness
InstanceProto
InstancesClient
Service Description: Manages instances of a version.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (InstancesClient instancesClient = InstancesClient.create()) {
GetInstanceRequest request = GetInstanceRequest.newBuilder().setName("name3373707").build();
Instance response = instancesClient.getInstance(request);
}
Note: close() needs to be called on the InstancesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of InstancesSettings to create(). For example:
To customize credentials:
InstancesSettings instancesSettings =
InstancesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
InstancesClient instancesClient = InstancesClient.create(instancesSettings);
To customize the endpoint:
InstancesSettings instancesSettings =
InstancesSettings.newBuilder().setEndpoint(myEndpoint).build();
InstancesClient instancesClient = InstancesClient.create(instancesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
InstancesClient.ListInstancesFixedSizeCollection
InstancesClient.ListInstancesPage
InstancesClient.ListInstancesPagedResponse
InstancesGrpc
Manages instances of a version.
InstancesGrpc.InstancesBlockingStub
Manages instances of a version.
InstancesGrpc.InstancesFutureStub
Manages instances of a version.
InstancesGrpc.InstancesImplBase
Manages instances of a version.
InstancesGrpc.InstancesStub
Manages instances of a version.
InstancesSettings
Settings class to configure an instance of InstancesClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getInstance to 30 seconds:
InstancesSettings.Builder instancesSettingsBuilder = InstancesSettings.newBuilder();
instancesSettingsBuilder
.getInstanceSettings()
.setRetrySettings(
instancesSettingsBuilder
.getInstanceSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
InstancesSettings instancesSettings = instancesSettingsBuilder.build();
InstancesSettings.Builder
Builder for InstancesSettings.
Library
Third-party Python runtime library that is required by the application.
Protobuf type google.appengine.v1.Library
Library.Builder
Third-party Python runtime library that is required by the application.
Protobuf type google.appengine.v1.Library
ListAuthorizedCertificatesRequest
Request message for AuthorizedCertificates.ListAuthorizedCertificates.
Protobuf type google.appengine.v1.ListAuthorizedCertificatesRequest
ListAuthorizedCertificatesRequest.Builder
Request message for AuthorizedCertificates.ListAuthorizedCertificates.
Protobuf type google.appengine.v1.ListAuthorizedCertificatesRequest
ListAuthorizedCertificatesResponse
Response message for AuthorizedCertificates.ListAuthorizedCertificates.
Protobuf type google.appengine.v1.ListAuthorizedCertificatesResponse
ListAuthorizedCertificatesResponse.Builder
Response message for AuthorizedCertificates.ListAuthorizedCertificates.
Protobuf type google.appengine.v1.ListAuthorizedCertificatesResponse
ListAuthorizedDomainsRequest
Request message for AuthorizedDomains.ListAuthorizedDomains.
Protobuf type google.appengine.v1.ListAuthorizedDomainsRequest
ListAuthorizedDomainsRequest.Builder
Request message for AuthorizedDomains.ListAuthorizedDomains.
Protobuf type google.appengine.v1.ListAuthorizedDomainsRequest
ListAuthorizedDomainsResponse
Response message for AuthorizedDomains.ListAuthorizedDomains.
Protobuf type google.appengine.v1.ListAuthorizedDomainsResponse
ListAuthorizedDomainsResponse.Builder
Response message for AuthorizedDomains.ListAuthorizedDomains.
Protobuf type google.appengine.v1.ListAuthorizedDomainsResponse
ListDomainMappingsRequest
Request message for DomainMappings.ListDomainMappings.
Protobuf type google.appengine.v1.ListDomainMappingsRequest
ListDomainMappingsRequest.Builder
Request message for DomainMappings.ListDomainMappings.
Protobuf type google.appengine.v1.ListDomainMappingsRequest
ListDomainMappingsResponse
Response message for DomainMappings.ListDomainMappings.
Protobuf type google.appengine.v1.ListDomainMappingsResponse
ListDomainMappingsResponse.Builder
Response message for DomainMappings.ListDomainMappings.
Protobuf type google.appengine.v1.ListDomainMappingsResponse
ListIngressRulesRequest
Request message for Firewall.ListIngressRules.
Protobuf type google.appengine.v1.ListIngressRulesRequest
ListIngressRulesRequest.Builder
Request message for Firewall.ListIngressRules.
Protobuf type google.appengine.v1.ListIngressRulesRequest
ListIngressRulesResponse
Response message for Firewall.ListIngressRules.
Protobuf type google.appengine.v1.ListIngressRulesResponse
ListIngressRulesResponse.Builder
Response message for Firewall.ListIngressRules.
Protobuf type google.appengine.v1.ListIngressRulesResponse
ListInstancesRequest
Request message for Instances.ListInstances.
Protobuf type google.appengine.v1.ListInstancesRequest
ListInstancesRequest.Builder
Request message for Instances.ListInstances.
Protobuf type google.appengine.v1.ListInstancesRequest
ListInstancesResponse
Response message for Instances.ListInstances.
Protobuf type google.appengine.v1.ListInstancesResponse
ListInstancesResponse.Builder
Response message for Instances.ListInstances.
Protobuf type google.appengine.v1.ListInstancesResponse
ListServicesRequest
Request message for Services.ListServices.
Protobuf type google.appengine.v1.ListServicesRequest
ListServicesRequest.Builder
Request message for Services.ListServices.
Protobuf type google.appengine.v1.ListServicesRequest
ListServicesResponse
Response message for Services.ListServices.
Protobuf type google.appengine.v1.ListServicesResponse
ListServicesResponse.Builder
Response message for Services.ListServices.
Protobuf type google.appengine.v1.ListServicesResponse
ListVersionsRequest
Request message for Versions.ListVersions.
Protobuf type google.appengine.v1.ListVersionsRequest
ListVersionsRequest.Builder
Request message for Versions.ListVersions.
Protobuf type google.appengine.v1.ListVersionsRequest
ListVersionsResponse
Response message for Versions.ListVersions.
Protobuf type google.appengine.v1.ListVersionsResponse
ListVersionsResponse.Builder
Response message for Versions.ListVersions.
Protobuf type google.appengine.v1.ListVersionsResponse
LivenessCheck
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
Protobuf type google.appengine.v1.LivenessCheck
LivenessCheck.Builder
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
Protobuf type google.appengine.v1.LivenessCheck
LocationMetadata
Metadata for the given google.cloud.location.Location.
Protobuf type google.appengine.v1.LocationMetadata
LocationMetadata.Builder
Metadata for the given google.cloud.location.Location.
Protobuf type google.appengine.v1.LocationMetadata
LocationProto
ManagedCertificate
A certificate managed by App Engine.
Protobuf type google.appengine.v1.ManagedCertificate
ManagedCertificate.Builder
A certificate managed by App Engine.
Protobuf type google.appengine.v1.ManagedCertificate
ManualScaling
A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Protobuf type google.appengine.v1.ManualScaling
ManualScaling.Builder
A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Protobuf type google.appengine.v1.ManualScaling
Network
Extra network settings. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.Network
Network.Builder
Extra network settings. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.Network
NetworkSettings
A NetworkSettings resource is a container for ingress settings for a version or service.
Protobuf type google.appengine.v1.NetworkSettings
NetworkSettings.Builder
A NetworkSettings resource is a container for ingress settings for a version or service.
Protobuf type google.appengine.v1.NetworkSettings
NetworkSettingsProto
NetworkUtilization
Target scaling by network usage. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.NetworkUtilization
NetworkUtilization.Builder
Target scaling by network usage. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.NetworkUtilization
OperationMetadataV1
Metadata for the given google.longrunning.Operation.
Protobuf type google.appengine.v1.OperationMetadataV1
OperationMetadataV1.Builder
Metadata for the given google.longrunning.Operation.
Protobuf type google.appengine.v1.OperationMetadataV1
OperationProto
ReadinessCheck
Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
Protobuf type google.appengine.v1.ReadinessCheck
ReadinessCheck.Builder
Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
Protobuf type google.appengine.v1.ReadinessCheck
RepairApplicationRequest
Request message for 'Applications.RepairApplication'.
Protobuf type google.appengine.v1.RepairApplicationRequest
RepairApplicationRequest.Builder
Request message for 'Applications.RepairApplication'.
Protobuf type google.appengine.v1.RepairApplicationRequest
RequestUtilization
Target scaling by request utilization. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.RequestUtilization
RequestUtilization.Builder
Target scaling by request utilization. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.RequestUtilization
ResourceRecord
A DNS resource record.
Protobuf type google.appengine.v1.ResourceRecord
ResourceRecord.Builder
A DNS resource record.
Protobuf type google.appengine.v1.ResourceRecord
Resources
Machine resources for a version.
Protobuf type google.appengine.v1.Resources
Resources.Builder
Machine resources for a version.
Protobuf type google.appengine.v1.Resources
ScriptHandler
Executes a script to handle the request that matches the URL pattern.
Protobuf type google.appengine.v1.ScriptHandler
ScriptHandler.Builder
Executes a script to handle the request that matches the URL pattern.
Protobuf type google.appengine.v1.ScriptHandler
Service
A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
Protobuf type google.appengine.v1.Service
Service.Builder
A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
Protobuf type google.appengine.v1.Service
ServiceProto
ServicesClient
Service Description: Manages services of an application.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (ServicesClient servicesClient = ServicesClient.create()) {
GetServiceRequest request = GetServiceRequest.newBuilder().setName("name3373707").build();
Service response = servicesClient.getService(request);
}
Note: close() needs to be called on the ServicesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ServicesSettings to create(). For example:
To customize credentials:
ServicesSettings servicesSettings =
ServicesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ServicesClient servicesClient = ServicesClient.create(servicesSettings);
To customize the endpoint:
ServicesSettings servicesSettings =
ServicesSettings.newBuilder().setEndpoint(myEndpoint).build();
ServicesClient servicesClient = ServicesClient.create(servicesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ServicesClient.ListServicesFixedSizeCollection
ServicesClient.ListServicesPage
ServicesClient.ListServicesPagedResponse
ServicesGrpc
Manages services of an application.
ServicesGrpc.ServicesBlockingStub
Manages services of an application.
ServicesGrpc.ServicesFutureStub
Manages services of an application.
ServicesGrpc.ServicesImplBase
Manages services of an application.
ServicesGrpc.ServicesStub
Manages services of an application.
ServicesSettings
Settings class to configure an instance of ServicesClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getService to 30 seconds:
ServicesSettings.Builder servicesSettingsBuilder = ServicesSettings.newBuilder();
servicesSettingsBuilder
.getServiceSettings()
.setRetrySettings(
servicesSettingsBuilder
.getServiceSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ServicesSettings servicesSettings = servicesSettingsBuilder.build();
ServicesSettings.Builder
Builder for ServicesSettings.
SslSettings
SSL configuration for a DomainMapping resource.
Protobuf type google.appengine.v1.SslSettings
SslSettings.Builder
SSL configuration for a DomainMapping resource.
Protobuf type google.appengine.v1.SslSettings
StandardSchedulerSettings
Scheduler settings for standard environment.
Protobuf type google.appengine.v1.StandardSchedulerSettings
StandardSchedulerSettings.Builder
Scheduler settings for standard environment.
Protobuf type google.appengine.v1.StandardSchedulerSettings
StaticFilesHandler
Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.
Protobuf type google.appengine.v1.StaticFilesHandler
StaticFilesHandler.Builder
Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.
Protobuf type google.appengine.v1.StaticFilesHandler
TrafficSplit
Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
Protobuf type google.appengine.v1.TrafficSplit
TrafficSplit.Builder
Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
Protobuf type google.appengine.v1.TrafficSplit
UpdateApplicationRequest
Request message for Applications.UpdateApplication.
Protobuf type google.appengine.v1.UpdateApplicationRequest
UpdateApplicationRequest.Builder
Request message for Applications.UpdateApplication.
Protobuf type google.appengine.v1.UpdateApplicationRequest
UpdateAuthorizedCertificateRequest
Request message for AuthorizedCertificates.UpdateAuthorizedCertificate.
Protobuf type google.appengine.v1.UpdateAuthorizedCertificateRequest
UpdateAuthorizedCertificateRequest.Builder
Request message for AuthorizedCertificates.UpdateAuthorizedCertificate.
Protobuf type google.appengine.v1.UpdateAuthorizedCertificateRequest
UpdateDomainMappingRequest
Request message for DomainMappings.UpdateDomainMapping.
Protobuf type google.appengine.v1.UpdateDomainMappingRequest
UpdateDomainMappingRequest.Builder
Request message for DomainMappings.UpdateDomainMapping.
Protobuf type google.appengine.v1.UpdateDomainMappingRequest
UpdateIngressRuleRequest
Request message for Firewall.UpdateIngressRule.
Protobuf type google.appengine.v1.UpdateIngressRuleRequest
UpdateIngressRuleRequest.Builder
Request message for Firewall.UpdateIngressRule.
Protobuf type google.appengine.v1.UpdateIngressRuleRequest
UpdateServiceMethod
Detailed information about UpdateService call.
Protobuf type google.appengine.v1.UpdateServiceMethod
UpdateServiceMethod.Builder
Detailed information about UpdateService call.
Protobuf type google.appengine.v1.UpdateServiceMethod
UpdateServiceRequest
Request message for Services.UpdateService.
Protobuf type google.appengine.v1.UpdateServiceRequest
UpdateServiceRequest.Builder
Request message for Services.UpdateService.
Protobuf type google.appengine.v1.UpdateServiceRequest
UpdateVersionRequest
Request message for Versions.UpdateVersion.
Protobuf type google.appengine.v1.UpdateVersionRequest
UpdateVersionRequest.Builder
Request message for Versions.UpdateVersion.
Protobuf type google.appengine.v1.UpdateVersionRequest
UrlDispatchRule
Rules to match an HTTP request and dispatch that request to a service.
Protobuf type google.appengine.v1.UrlDispatchRule
UrlDispatchRule.Builder
Rules to match an HTTP request and dispatch that request to a service.
Protobuf type google.appengine.v1.UrlDispatchRule
UrlMap
URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
Protobuf type google.appengine.v1.UrlMap
UrlMap.Builder
URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
Protobuf type google.appengine.v1.UrlMap
Version
A Version resource is a specific set of source code and configuration files that are deployed into a service.
Protobuf type google.appengine.v1.Version
Version.Builder
A Version resource is a specific set of source code and configuration files that are deployed into a service.
Protobuf type google.appengine.v1.Version
VersionProto
VersionsClient
Service Description: Manages versions of a service.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (VersionsClient versionsClient = VersionsClient.create()) {
GetVersionRequest request =
GetVersionRequest.newBuilder()
.setName("name3373707")
.setView(VersionView.forNumber(0))
.build();
Version response = versionsClient.getVersion(request);
}
Note: close() needs to be called on the VersionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of VersionsSettings to create(). For example:
To customize credentials:
VersionsSettings versionsSettings =
VersionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
To customize the endpoint:
VersionsSettings versionsSettings =
VersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
VersionsClient.ListVersionsFixedSizeCollection
VersionsClient.ListVersionsPage
VersionsClient.ListVersionsPagedResponse
VersionsGrpc
Manages versions of a service.
VersionsGrpc.VersionsBlockingStub
Manages versions of a service.
VersionsGrpc.VersionsFutureStub
Manages versions of a service.
VersionsGrpc.VersionsImplBase
Manages versions of a service.
VersionsGrpc.VersionsStub
Manages versions of a service.
VersionsSettings
Settings class to configure an instance of VersionsClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getVersion to 30 seconds:
VersionsSettings.Builder versionsSettingsBuilder = VersionsSettings.newBuilder();
versionsSettingsBuilder
.getVersionSettings()
.setRetrySettings(
versionsSettingsBuilder
.getVersionSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
VersionsSettings versionsSettings = versionsSettingsBuilder.build();
VersionsSettings.Builder
Builder for VersionsSettings.
Volume
Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.Volume
Volume.Builder
Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
Protobuf type google.appengine.v1.Volume
VpcAccessConnector
VPC access connector specification.
Protobuf type google.appengine.v1.VpcAccessConnector
VpcAccessConnector.Builder
VPC access connector specification.
Protobuf type google.appengine.v1.VpcAccessConnector
ZipInfo
The zip file information for a zip deployment.
Protobuf type google.appengine.v1.ZipInfo
ZipInfo.Builder
The zip file information for a zip deployment.
Protobuf type google.appengine.v1.ZipInfo
Interfaces
ApiConfigHandlerOrBuilder
ApiEndpointHandlerOrBuilder
Application.FeatureSettingsOrBuilder
Application.IdentityAwareProxyOrBuilder
ApplicationOrBuilder
AuditDataOrBuilder
AuthorizedCertificateOrBuilder
AuthorizedDomainOrBuilder
AutomaticScalingOrBuilder
BasicScalingOrBuilder
BatchUpdateIngressRulesRequestOrBuilder
BatchUpdateIngressRulesResponseOrBuilder
CertificateRawDataOrBuilder
CloudBuildOptionsOrBuilder
ContainerInfoOrBuilder
CpuUtilizationOrBuilder
CreateApplicationRequestOrBuilder
CreateAuthorizedCertificateRequestOrBuilder
CreateDomainMappingRequestOrBuilder
CreateIngressRuleRequestOrBuilder
CreateVersionMetadataV1OrBuilder
CreateVersionMethodOrBuilder
CreateVersionRequestOrBuilder
DebugInstanceRequestOrBuilder
DeleteAuthorizedCertificateRequestOrBuilder
DeleteDomainMappingRequestOrBuilder
DeleteIngressRuleRequestOrBuilder
DeleteInstanceRequestOrBuilder
DeleteServiceRequestOrBuilder
DeleteVersionRequestOrBuilder
DeploymentOrBuilder
DiskUtilizationOrBuilder
DomainMappingOrBuilder
EndpointsApiServiceOrBuilder
EntrypointOrBuilder
ErrorHandlerOrBuilder
FileInfoOrBuilder
GetApplicationRequestOrBuilder
GetAuthorizedCertificateRequestOrBuilder
GetDomainMappingRequestOrBuilder
GetIngressRuleRequestOrBuilder
GetInstanceRequestOrBuilder
GetServiceRequestOrBuilder
GetVersionRequestOrBuilder
HealthCheckOrBuilder
Instance.LivenessOrBuilder
InstanceOrBuilder
LibraryOrBuilder
ListAuthorizedCertificatesRequestOrBuilder
ListAuthorizedCertificatesResponseOrBuilder
ListAuthorizedDomainsRequestOrBuilder
ListAuthorizedDomainsResponseOrBuilder
ListDomainMappingsRequestOrBuilder
ListDomainMappingsResponseOrBuilder
ListIngressRulesRequestOrBuilder
ListIngressRulesResponseOrBuilder
ListInstancesRequestOrBuilder
ListInstancesResponseOrBuilder
ListServicesRequestOrBuilder
ListServicesResponseOrBuilder
ListVersionsRequestOrBuilder
ListVersionsResponseOrBuilder
LivenessCheckOrBuilder
LocationMetadataOrBuilder
ManagedCertificateOrBuilder
ManualScalingOrBuilder
NetworkOrBuilder
NetworkSettingsOrBuilder
NetworkUtilizationOrBuilder
OperationMetadataV1OrBuilder
ReadinessCheckOrBuilder
RepairApplicationRequestOrBuilder
RequestUtilizationOrBuilder
ResourceRecordOrBuilder
ResourcesOrBuilder
ScriptHandlerOrBuilder
ServiceOrBuilder
SslSettingsOrBuilder
StandardSchedulerSettingsOrBuilder
StaticFilesHandlerOrBuilder
TrafficSplitOrBuilder
UpdateApplicationRequestOrBuilder
UpdateAuthorizedCertificateRequestOrBuilder
UpdateDomainMappingRequestOrBuilder
UpdateIngressRuleRequestOrBuilder
UpdateServiceMethodOrBuilder
UpdateServiceRequestOrBuilder
UpdateVersionRequestOrBuilder
UrlDispatchRuleOrBuilder
UrlMapOrBuilder
VersionOrBuilder
VolumeOrBuilder
VpcAccessConnectorOrBuilder
ZipInfoOrBuilder
Enums
Application.DatabaseType
Protobuf enum google.appengine.v1.Application.DatabaseType
Application.ServingStatus
Protobuf enum google.appengine.v1.Application.ServingStatus
AuditData.MethodCase
AuthFailAction
Actions to take when the user is not logged in.
Protobuf enum google.appengine.v1.AuthFailAction
AuthorizedCertificateView
Fields that should be returned when an AuthorizedCertificate resource is retrieved.
Protobuf enum google.appengine.v1.AuthorizedCertificateView
DomainOverrideStrategy
Override strategy for mutating an existing mapping.
Protobuf enum google.appengine.v1.DomainOverrideStrategy
EndpointsApiService.RolloutStrategy
Available rollout strategies.
Protobuf enum google.appengine.v1.EndpointsApiService.RolloutStrategy
Entrypoint.CommandCase
ErrorHandler.ErrorCode
Error codes.
Protobuf enum google.appengine.v1.ErrorHandler.ErrorCode
InboundServiceType
Available inbound services.
Protobuf enum google.appengine.v1.InboundServiceType
Instance.Availability
Availability of the instance.
Protobuf enum google.appengine.v1.Instance.Availability
Instance.Liveness.LivenessState
Liveness health check status for Flex instances.
Protobuf enum google.appengine.v1.Instance.Liveness.LivenessState
LoginRequirement
Methods to restrict access to a URL based on login status.
Protobuf enum google.appengine.v1.LoginRequirement
ManagementStatus
State of certificate management. Refers to the most recent certificate acquisition or renewal attempt.
Protobuf enum google.appengine.v1.ManagementStatus
NetworkSettings.IngressTrafficAllowed
If unspecified, INGRESS_TRAFFIC_ALLOWED_ALL will be used.
Protobuf enum google.appengine.v1.NetworkSettings.IngressTrafficAllowed
OperationMetadataV1.MethodMetadataCase
ResourceRecord.RecordType
A resource record type.
Protobuf enum google.appengine.v1.ResourceRecord.RecordType
SecurityLevel
Methods to enforce security (HTTPS) on a URL.
Protobuf enum google.appengine.v1.SecurityLevel
ServingStatus
Run states of a version.
Protobuf enum google.appengine.v1.ServingStatus
SslSettings.SslManagementType
The SSL management type for this domain.
Protobuf enum google.appengine.v1.SslSettings.SslManagementType
TrafficSplit.ShardBy
Available sharding mechanisms.
Protobuf enum google.appengine.v1.TrafficSplit.ShardBy
UrlMap.HandlerTypeCase
UrlMap.RedirectHttpResponseCode
Redirect codes.
Protobuf enum google.appengine.v1.UrlMap.RedirectHttpResponseCode
Version.ScalingCase
VersionView
Fields that should be returned when Version resources are retrieved.
Protobuf enum google.appengine.v1.VersionView