Google_AddressesServiceResource

The "addresses" collection of methods.

Defined (1)

The class is defined in the following location(s).

/google-api-php-client/src/contrib/Google_ComputeService.php  
  1. class Google_AddressesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Retrieves the list of addresses grouped by scope. (addresses.aggregatedList) 
  5. * @param string $project Name of the project scoping this request. 
  6. * @param array $optParams Optional parameters. 
  7. * @opt_param string filter Optional. Filter expression for filtering listed resources. 
  8. * @opt_param string maxResults Optional. Maximum count of results to be returned. Maximum and default value is 100. 
  9. * @opt_param string pageToken Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request. 
  10. * @return Google_AddressAggregatedList 
  11. */ 
  12. public function aggregatedList($project, $optParams = array()) { 
  13. $params = array('project' => $project); 
  14. $params = array_merge($params, $optParams); 
  15. $data = $this->__call('aggregatedList', array($params)); 
  16. if ($this->useObjects()) { 
  17. return new Google_AddressAggregatedList($data); 
  18. } else { 
  19. return $data; 
  20. /** 
  21. * Deletes the specified address resource. (addresses.delete) 
  22. * @param string $project Name of the project scoping this request. 
  23. * @param string $region Name of the region scoping this request. 
  24. * @param string $address Name of the address resource to delete. 
  25. * @param array $optParams Optional parameters. 
  26. * @return Google_Operation 
  27. */ 
  28. public function delete($project, $region, $address, $optParams = array()) { 
  29. $params = array('project' => $project, 'region' => $region, 'address' => $address); 
  30. $params = array_merge($params, $optParams); 
  31. $data = $this->__call('delete', array($params)); 
  32. if ($this->useObjects()) { 
  33. return new Google_Operation($data); 
  34. } else { 
  35. return $data; 
  36. /** 
  37. * Returns the specified address resource. (addresses.get) 
  38. * @param string $project Name of the project scoping this request. 
  39. * @param string $region Name of the region scoping this request. 
  40. * @param string $address Name of the address resource to return. 
  41. * @param array $optParams Optional parameters. 
  42. * @return Google_Address 
  43. */ 
  44. public function get($project, $region, $address, $optParams = array()) { 
  45. $params = array('project' => $project, 'region' => $region, 'address' => $address); 
  46. $params = array_merge($params, $optParams); 
  47. $data = $this->__call('get', array($params)); 
  48. if ($this->useObjects()) { 
  49. return new Google_Address($data); 
  50. } else { 
  51. return $data; 
  52. /** 
  53. * Creates an address resource in the specified project using the data included in the request. 
  54. * (addresses.insert) 
  55. * @param string $project Name of the project scoping this request. 
  56. * @param string $region Name of the region scoping this request. 
  57. * @param Google_Address $postBody 
  58. * @param array $optParams Optional parameters. 
  59. * @return Google_Operation 
  60. */ 
  61. public function insert($project, $region, Google_Address $postBody, $optParams = array()) { 
  62. $params = array('project' => $project, 'region' => $region, 'postBody' => $postBody); 
  63. $params = array_merge($params, $optParams); 
  64. $data = $this->__call('insert', array($params)); 
  65. if ($this->useObjects()) { 
  66. return new Google_Operation($data); 
  67. } else { 
  68. return $data; 
  69. /** 
  70. * Retrieves the list of address resources contained within the specified region. (addresses.list) 
  71. * @param string $project Name of the project scoping this request. 
  72. * @param string $region Name of the region scoping this request. 
  73. * @param array $optParams Optional parameters. 
  74. * @opt_param string filter Optional. Filter expression for filtering listed resources. 
  75. * @opt_param string maxResults Optional. Maximum count of results to be returned. Maximum and default value is 100. 
  76. * @opt_param string pageToken Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request. 
  77. * @return Google_AddressList 
  78. */ 
  79. public function listAddresses($project, $region, $optParams = array()) { 
  80. $params = array('project' => $project, 'region' => $region); 
  81. $params = array_merge($params, $optParams); 
  82. $data = $this->__call('list', array($params)); 
  83. if ($this->useObjects()) { 
  84. return new Google_AddressList($data); 
  85. } else { 
  86. return $data;