* $firebaseapphostingService = new Google\Service\FirebaseAppHosting(...); * $domains = $firebaseapphostingService->projects_locations_backends_domains; * */ class ProjectsLocationsBackendsDomains extends \Google\Service\Resource { /** * Links a new domain to a backend. (domains.create) * * @param string $parent Required. The parent backend in the format: * `projects/{project}/locations/{locationId}/backends/{backendId}`. * @param Domain $postBody * @param array $optParams Optional parameters. * * @opt_param string domainId Required. Id of the domain to create. Must be a * valid domain name. * @opt_param string requestId Optional. An optional request ID to identify * requests. Specify a unique request ID so that if you must retry your request, * the server will know to ignore the request if it has already been completed. * The server will guarantee that for at least 60 minutes since the first * request. For example, consider a situation where you make an initial request * and the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same request * ID was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. The request ID must * be a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @opt_param bool validateOnly Optional. Indicates that the request should be * validated and default values populated, without persisting the request or * creating any resources. * @return Operation * @throws \Google\Service\Exception */ public function create($parent, Domain $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Operation::class); } /** * Deletes a single domain. (domains.delete) * * @param string $name Required. Name of the resource in the format: `projects/{ * project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`. * @param array $optParams Optional parameters. * * @opt_param string etag Optional. If the client provided etag is out of date, * delete will be returned FAILED_PRECONDITION error. * @opt_param string requestId Optional. An optional request ID to identify * requests. Specify a unique request ID so that if you must retry your request, * the server will know to ignore the request if it has already been completed. * The server will guarantee that for at least 60 minutes after the first * request. For example, consider a situation where you make an initial request * and the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same request * ID was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. The request ID must * be a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @opt_param bool validateOnly Optional. Indicates that the request should be * validated and default values populated, without persisting the request or * deleting any resources. * @return Operation * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], Operation::class); } /** * Gets information about a domain. (domains.get) * * @param string $name Required. Name of the resource in the format: `projects/{ * project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`. * @param array $optParams Optional parameters. * @return Domain * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Domain::class); } /** * Lists domains of a backend. (domains.listProjectsLocationsBackendsDomains) * * @param string $parent Required. The parent backend in the format: * `projects/{project}/locations/{locationId}/backends/{backendId}`. * @param array $optParams Optional parameters. * * @opt_param string filter Optional. A filter to narrow down results to a * preferred subset. Learn more about filtering in Google's [AIP 160 * standard](https://google.aip.dev/160). * @opt_param string orderBy Optional. Hint for how to order the results. * Supported fields are `name` and `createTime`. To specify descending order, * append a `desc` suffix. * @opt_param int pageSize Optional. The maximum number of results to return. If * not set, the service selects a default. * @opt_param string pageToken Optional. A page token received from the * nextPageToken field in the response. Send that page token to receive the * subsequent page. * @opt_param bool showDeleted Optional. If true, the request returns soft- * deleted resources that haven't been fully-deleted yet. * @return ListDomainsResponse * @throws \Google\Service\Exception */ public function listProjectsLocationsBackendsDomains($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListDomainsResponse::class); } /** * Updates the information for a single domain. (domains.patch) * * @param string $name Identifier. The resource name of the domain, e.g. * `/projects/p/locations/l/backends/b/domains/foo.com` * @param Domain $postBody * @param array $optParams Optional parameters. * * @opt_param bool allowMissing Optional. If set to true, and the domain is not * found, a new domain will be created. * @opt_param string requestId Optional. An optional request ID to identify * requests. Specify a unique request ID so that if you must retry your request, * the server will know to ignore the request if it has already been completed. * The server will guarantee that for at least 60 minutes since the first * request. For example, consider a situation where you make an initial request * and the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same request * ID was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. The request ID must * be a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @opt_param string updateMask Optional. Field mask is used to specify the * fields to be overwritten in the Domain resource by the update. The fields * specified in the update_mask are relative to the resource, not the full * request. A field will be overwritten if it is in the mask. If the user does * not provide a mask then all fields will be overwritten. * @opt_param bool validateOnly Optional. Indicates that the request should be * validated and default values populated, without persisting the request or * modifying any resources. * @return Operation * @throws \Google\Service\Exception */ public function patch($name, Domain $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Operation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsBackendsDomains::class, 'Google_Service_FirebaseAppHosting_Resource_ProjectsLocationsBackendsDomains');