* $computeService = new Google\Service\Compute(...); * $targetHttpProxies = $computeService->targetHttpProxies; * */ class TargetHttpProxies extends \Google\Service\Resource { /** * Retrieves the list of all TargetHttpProxy resources, regional and global, * available to the specified project. (targetHttpProxies.aggregatedList) * * @param string $project Name of the project scoping this request. * @param array $optParams Optional parameters. * * @opt_param string filter A filter expression that filters resources listed in * the response. The expression must specify the field name, an operator, and * the value that you want to use for filtering. The value must be a string, a * number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, * `>=` or `:`. For example, if you are filtering Compute Engine instances, you * can exclude instances named `example-instance` by specifying `name != * example-instance`. The `:` operator can be used with string fields to match * substrings. For non-string fields it is equivalent to the `=` operator. The * `:*` comparison can be used to test whether a key has been defined. For * example, to find all objects with `owner` label use: ``` labels.owner:* ``` * You can also filter nested fields. For example, you could specify * `scheduling.automaticRestart = false` to include instances only if they are * not scheduled for automatic restarts. You can use filtering on nested fields * to filter based on resource labels. To filter on multiple expressions, * provide each separate expression within parentheses. For example: ``` * (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By * default, each expression is an `AND` expression. However, you can include * `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel * Skylake") OR (cpuPlatform = "Intel Broadwell") AND * (scheduling.automaticRestart = true) ``` * @opt_param bool includeAllScopes Indicates whether every visible scope for * each scope type (zone, region, global) should be included in the response. * For new resource types added after this field, the flag has no effect as new * resource types will always include every visible scope for each scope type in * response. For resource types which predate this field, if this flag is * omitted or false, only scopes of the scope types where the resource type is * expected to be found will be included. * @opt_param string maxResults The maximum number of results per page that * should be returned. If the number of available results is larger than * `maxResults`, Compute Engine returns a `nextPageToken` that can be used to * get the next page of results in subsequent list requests. Acceptable values * are `0` to `500`, inclusive. (Default: `500`) * @opt_param string orderBy Sorts list results by a certain order. By default, * results are returned in alphanumerical order based on the resource name. You * can also sort results in descending order based on the creation timestamp * using `orderBy="creationTimestamp desc"`. This sorts results based on the * `creationTimestamp` field in reverse chronological order (newest result * first). Use this to sort resources like operations so that the newest * operation is returned first. Currently, only sorting by `name` or * `creationTimestamp desc` is supported. * @opt_param string pageToken Specifies a page token to use. Set `pageToken` to * the `nextPageToken` returned by a previous list request to get the next page * of results. * @opt_param bool returnPartialSuccess Opt-in for partial success behavior * which provides partial results in case of failure. The default value is * false. * @return TargetHttpProxyAggregatedList */ public function aggregatedList($project, $optParams = []) { $params = ['project' => $project]; $params = array_merge($params, $optParams); return $this->call('aggregatedList', [$params], TargetHttpProxyAggregatedList::class); } /** * Deletes the specified TargetHttpProxy resource. (targetHttpProxies.delete) * * @param string $project Project ID for this request. * @param string $targetHttpProxy Name of the TargetHttpProxy resource to * delete. * @param array $optParams Optional parameters. * * @opt_param string requestId 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. 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). * @return Operation */ public function delete($project, $targetHttpProxy, $optParams = []) { $params = ['project' => $project, 'targetHttpProxy' => $targetHttpProxy]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], Operation::class); } /** * Returns the specified TargetHttpProxy resource. Gets a list of available * target HTTP proxies by making a list() request. (targetHttpProxies.get) * * @param string $project Project ID for this request. * @param string $targetHttpProxy Name of the TargetHttpProxy resource to * return. * @param array $optParams Optional parameters. * @return TargetHttpProxy */ public function get($project, $targetHttpProxy, $optParams = []) { $params = ['project' => $project, 'targetHttpProxy' => $targetHttpProxy]; $params = array_merge($params, $optParams); return $this->call('get', [$params], TargetHttpProxy::class); } /** * Creates a TargetHttpProxy resource in the specified project using the data * included in the request. (targetHttpProxies.insert) * * @param string $project Project ID for this request. * @param TargetHttpProxy $postBody * @param array $optParams Optional parameters. * * @opt_param string requestId 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. 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). * @return Operation */ public function insert($project, TargetHttpProxy $postBody, $optParams = []) { $params = ['project' => $project, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('insert', [$params], Operation::class); } /** * Retrieves the list of TargetHttpProxy resources available to the specified * project. (targetHttpProxies.listTargetHttpProxies) * * @param string $project Project ID for this request. * @param array $optParams Optional parameters. * * @opt_param string filter A filter expression that filters resources listed in * the response. The expression must specify the field name, an operator, and * the value that you want to use for filtering. The value must be a string, a * number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, * `>=` or `:`. For example, if you are filtering Compute Engine instances, you * can exclude instances named `example-instance` by specifying `name != * example-instance`. The `:` operator can be used with string fields to match * substrings. For non-string fields it is equivalent to the `=` operator. The * `:*` comparison can be used to test whether a key has been defined. For * example, to find all objects with `owner` label use: ``` labels.owner:* ``` * You can also filter nested fields. For example, you could specify * `scheduling.automaticRestart = false` to include instances only if they are * not scheduled for automatic restarts. You can use filtering on nested fields * to filter based on resource labels. To filter on multiple expressions, * provide each separate expression within parentheses. For example: ``` * (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By * default, each expression is an `AND` expression. However, you can include * `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel * Skylake") OR (cpuPlatform = "Intel Broadwell") AND * (scheduling.automaticRestart = true) ``` * @opt_param string maxResults The maximum number of results per page that * should be returned. If the number of available results is larger than * `maxResults`, Compute Engine returns a `nextPageToken` that can be used to * get the next page of results in subsequent list requests. Acceptable values * are `0` to `500`, inclusive. (Default: `500`) * @opt_param string orderBy Sorts list results by a certain order. By default, * results are returned in alphanumerical order based on the resource name. You * can also sort results in descending order based on the creation timestamp * using `orderBy="creationTimestamp desc"`. This sorts results based on the * `creationTimestamp` field in reverse chronological order (newest result * first). Use this to sort resources like operations so that the newest * operation is returned first. Currently, only sorting by `name` or * `creationTimestamp desc` is supported. * @opt_param string pageToken Specifies a page token to use. Set `pageToken` to * the `nextPageToken` returned by a previous list request to get the next page * of results. * @opt_param bool returnPartialSuccess Opt-in for partial success behavior * which provides partial results in case of failure. The default value is * false. * @return TargetHttpProxyList */ public function listTargetHttpProxies($project, $optParams = []) { $params = ['project' => $project]; $params = array_merge($params, $optParams); return $this->call('list', [$params], TargetHttpProxyList::class); } /** * Patches the specified TargetHttpProxy resource with the data included in the * request. This method supports PATCH semantics and uses JSON merge patch * format and processing rules. (targetHttpProxies.patch) * * @param string $project Project ID for this request. * @param string $targetHttpProxy Name of the TargetHttpProxy resource to patch. * @param TargetHttpProxy $postBody * @param array $optParams Optional parameters. * * @opt_param string requestId 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. 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). * @return Operation */ public function patch($project, $targetHttpProxy, TargetHttpProxy $postBody, $optParams = []) { $params = ['project' => $project, 'targetHttpProxy' => $targetHttpProxy, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Operation::class); } /** * Changes the URL map for TargetHttpProxy. (targetHttpProxies.setUrlMap) * * @param string $project Project ID for this request. * @param string $targetHttpProxy Name of the TargetHttpProxy to set a URL map * for. * @param UrlMapReference $postBody * @param array $optParams Optional parameters. * * @opt_param string requestId 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. 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). * @return Operation */ public function setUrlMap($project, $targetHttpProxy, UrlMapReference $postBody, $optParams = []) { $params = ['project' => $project, 'targetHttpProxy' => $targetHttpProxy, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('setUrlMap', [$params], Operation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(TargetHttpProxies::class, 'Google_Service_Compute_Resource_TargetHttpProxies');