Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class 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:
$applicationsClient = new ApplicationsClient();
try {
$operationResponse = $applicationsClient->createApplication();
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $applicationsClient->createApplication();
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $applicationsClient->resumeOperation($operationName, 'createApplication');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$applicationsClient->close();
}
This service has a new (beta) implementation. See Google\Cloud\AppEngine\V1\Client\ApplicationsClient to use the new surface.
Namespace
Google \ Cloud \ AppEngine \ V1Methods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
createApplication
Creates an App Engine application for a Google Cloud Platform project.
Required fields:
-
id- The ID of the target Cloud Platform project. - location - The region where you want the App Engine application located.
For more information about App Engine applications, see Managing Projects, Applications, and Billing .
optionalArgs
array
Optional.
↳ application
Application
Application configuration.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AppEngine\V1\Application;
use Google\Cloud\AppEngine\V1\ApplicationsClient;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function create_application_sample(): void
{
// Create a client.
$applicationsClient = new ApplicationsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $applicationsClient->createApplication();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Application $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getApplication
Gets information about an application.
optionalArgs
array
Optional.
↳ name
string
Name of the Application resource to get. Example: apps/myapp
.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\Application;
use Google\Cloud\AppEngine\V1\ApplicationsClient;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function get_application_sample(): void
{
// Create a client.
$applicationsClient = new ApplicationsClient();
// Call the API and handle any network failures.
try {
/** @var Application $response */
$response = $applicationsClient->getApplication();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
repairApplication
Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account.
Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account . If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.
optionalArgs
array
Optional.
↳ name
string
Name of the application to repair. Example: apps/myapp
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AppEngine\V1\Application;
use Google\Cloud\AppEngine\V1\ApplicationsClient;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function repair_application_sample(): void
{
// Create a client.
$applicationsClient = new ApplicationsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $applicationsClient->repairApplication();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Application $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateApplication
Updates the specified Application resource.
You can update the following fields:
-
auth_domain- Google authentication domain for controlling user access to the application. -
default_cookie_expiration- Cookie expiration policy for the application. -
iap- Identity-Aware Proxy properties for the application.
optionalArgs
array
Optional.
↳ name
string
Name of the Application resource to update. Example: apps/myapp
.
↳ application
Application
An Application containing the updated resource.
↳ updateMask
FieldMask
Required. Standard field mask for the set of fields to be updated.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AppEngine\V1\Application;
use Google\Cloud\AppEngine\V1\ApplicationsClient;
use Google\Rpc\Status;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_application_sample(): void
{
// Create a client.
$applicationsClient = new ApplicationsClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $applicationsClient->updateApplication();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Application $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
Constants
SERVICE_NAME
Value: 'google.appengine.v1.Applications'
The name of the service.
SERVICE_ADDRESS
Value: 'appengine.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.
