[e3d4e0a] | 1 | <?php
|
---|
| 2 | /*
|
---|
| 3 | * Copyright 2014 Google Inc.
|
---|
| 4 | *
|
---|
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
| 6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
| 7 | * the License at
|
---|
| 8 | *
|
---|
| 9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
| 10 | *
|
---|
| 11 | * Unless required by applicable law or agreed to in writing, software
|
---|
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
| 14 | * License for the specific language governing permissions and limitations under
|
---|
| 15 | * the License.
|
---|
| 16 | */
|
---|
| 17 |
|
---|
| 18 | namespace Google\Service\CloudDomains\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\CloudDomains\AuthorizationCode;
|
---|
| 21 | use Google\Service\CloudDomains\ConfigureContactSettingsRequest;
|
---|
| 22 | use Google\Service\CloudDomains\ConfigureDnsSettingsRequest;
|
---|
| 23 | use Google\Service\CloudDomains\ConfigureManagementSettingsRequest;
|
---|
| 24 | use Google\Service\CloudDomains\ExportRegistrationRequest;
|
---|
| 25 | use Google\Service\CloudDomains\ImportDomainRequest;
|
---|
| 26 | use Google\Service\CloudDomains\InitiatePushTransferRequest;
|
---|
| 27 | use Google\Service\CloudDomains\ListRegistrationsResponse;
|
---|
| 28 | use Google\Service\CloudDomains\Operation;
|
---|
| 29 | use Google\Service\CloudDomains\Policy;
|
---|
| 30 | use Google\Service\CloudDomains\RegisterDomainRequest;
|
---|
| 31 | use Google\Service\CloudDomains\Registration;
|
---|
| 32 | use Google\Service\CloudDomains\RenewDomainRequest;
|
---|
| 33 | use Google\Service\CloudDomains\ResetAuthorizationCodeRequest;
|
---|
| 34 | use Google\Service\CloudDomains\RetrieveGoogleDomainsDnsRecordsResponse;
|
---|
| 35 | use Google\Service\CloudDomains\RetrieveGoogleDomainsForwardingConfigResponse;
|
---|
| 36 | use Google\Service\CloudDomains\RetrieveImportableDomainsResponse;
|
---|
| 37 | use Google\Service\CloudDomains\RetrieveRegisterParametersResponse;
|
---|
| 38 | use Google\Service\CloudDomains\RetrieveTransferParametersResponse;
|
---|
| 39 | use Google\Service\CloudDomains\SearchDomainsResponse;
|
---|
| 40 | use Google\Service\CloudDomains\SetIamPolicyRequest;
|
---|
| 41 | use Google\Service\CloudDomains\TestIamPermissionsRequest;
|
---|
| 42 | use Google\Service\CloudDomains\TestIamPermissionsResponse;
|
---|
| 43 | use Google\Service\CloudDomains\TransferDomainRequest;
|
---|
| 44 |
|
---|
| 45 | /**
|
---|
| 46 | * The "registrations" collection of methods.
|
---|
| 47 | * Typical usage is:
|
---|
| 48 | * <code>
|
---|
| 49 | * $domainsService = new Google\Service\CloudDomains(...);
|
---|
| 50 | * $registrations = $domainsService->projects_locations_registrations;
|
---|
| 51 | * </code>
|
---|
| 52 | */
|
---|
| 53 | class ProjectsLocationsRegistrations extends \Google\Service\Resource
|
---|
| 54 | {
|
---|
| 55 | /**
|
---|
| 56 | * Updates a `Registration`'s contact settings. Some changes require
|
---|
| 57 | * confirmation by the domain's registrant contact . Caution: Please consider
|
---|
| 58 | * carefully any changes to contact privacy settings when changing from
|
---|
| 59 | * `REDACTED_CONTACT_DATA` to `PUBLIC_CONTACT_DATA.` There may be a delay in
|
---|
| 60 | * reflecting updates you make to registrant contact information such that any
|
---|
| 61 | * changes you make to contact privacy (including from `REDACTED_CONTACT_DATA`
|
---|
| 62 | * to `PUBLIC_CONTACT_DATA`) will be applied without delay but changes to
|
---|
| 63 | * registrant contact information may take a limited time to be publicized. This
|
---|
| 64 | * means that changes to contact privacy from `REDACTED_CONTACT_DATA` to
|
---|
| 65 | * `PUBLIC_CONTACT_DATA` may make the previous registrant contact data public
|
---|
| 66 | * until the modified registrant contact details are published.
|
---|
| 67 | * (registrations.configureContactSettings)
|
---|
| 68 | *
|
---|
| 69 | * @param string $registration Required. The name of the `Registration` whose
|
---|
| 70 | * contact settings are being updated, in the format
|
---|
| 71 | * `projects/locations/registrations`.
|
---|
| 72 | * @param ConfigureContactSettingsRequest $postBody
|
---|
| 73 | * @param array $optParams Optional parameters.
|
---|
| 74 | * @return Operation
|
---|
| 75 | * @throws \Google\Service\Exception
|
---|
| 76 | */
|
---|
| 77 | public function configureContactSettings($registration, ConfigureContactSettingsRequest $postBody, $optParams = [])
|
---|
| 78 | {
|
---|
| 79 | $params = ['registration' => $registration, 'postBody' => $postBody];
|
---|
| 80 | $params = array_merge($params, $optParams);
|
---|
| 81 | return $this->call('configureContactSettings', [$params], Operation::class);
|
---|
| 82 | }
|
---|
| 83 | /**
|
---|
| 84 | * Updates a `Registration`'s DNS settings. (registrations.configureDnsSettings)
|
---|
| 85 | *
|
---|
| 86 | * @param string $registration Required. The name of the `Registration` whose
|
---|
| 87 | * DNS settings are being updated, in the format
|
---|
| 88 | * `projects/locations/registrations`.
|
---|
| 89 | * @param ConfigureDnsSettingsRequest $postBody
|
---|
| 90 | * @param array $optParams Optional parameters.
|
---|
| 91 | * @return Operation
|
---|
| 92 | * @throws \Google\Service\Exception
|
---|
| 93 | */
|
---|
| 94 | public function configureDnsSettings($registration, ConfigureDnsSettingsRequest $postBody, $optParams = [])
|
---|
| 95 | {
|
---|
| 96 | $params = ['registration' => $registration, 'postBody' => $postBody];
|
---|
| 97 | $params = array_merge($params, $optParams);
|
---|
| 98 | return $this->call('configureDnsSettings', [$params], Operation::class);
|
---|
| 99 | }
|
---|
| 100 | /**
|
---|
| 101 | * Updates a `Registration`'s management settings.
|
---|
| 102 | * (registrations.configureManagementSettings)
|
---|
| 103 | *
|
---|
| 104 | * @param string $registration Required. The name of the `Registration` whose
|
---|
| 105 | * management settings are being updated, in the format
|
---|
| 106 | * `projects/locations/registrations`.
|
---|
| 107 | * @param ConfigureManagementSettingsRequest $postBody
|
---|
| 108 | * @param array $optParams Optional parameters.
|
---|
| 109 | * @return Operation
|
---|
| 110 | * @throws \Google\Service\Exception
|
---|
| 111 | */
|
---|
| 112 | public function configureManagementSettings($registration, ConfigureManagementSettingsRequest $postBody, $optParams = [])
|
---|
| 113 | {
|
---|
| 114 | $params = ['registration' => $registration, 'postBody' => $postBody];
|
---|
| 115 | $params = array_merge($params, $optParams);
|
---|
| 116 | return $this->call('configureManagementSettings', [$params], Operation::class);
|
---|
| 117 | }
|
---|
| 118 | /**
|
---|
| 119 | * Deletes a `Registration` resource. This method works on any `Registration`
|
---|
| 120 | * resource using [Subscription or Commitment billing](/domains/pricing#billing-
|
---|
| 121 | * models), provided that the resource was created at least 1 day in the past.
|
---|
| 122 | * When an active registration is successfully deleted, you can continue to use
|
---|
| 123 | * the domain in [Google Domains](https://domains.google/) until it expires. The
|
---|
| 124 | * calling user becomes the domain's sole owner in Google Domains, and
|
---|
| 125 | * permissions for the domain are subsequently managed there. The domain does
|
---|
| 126 | * not renew automatically unless the new owner sets up billing in Google
|
---|
| 127 | * Domains. After January 2024 you will only be able to delete `Registration`
|
---|
| 128 | * resources when `state` is one of: `EXPORTED`, `EXPIRED`,`REGISTRATION_FAILED`
|
---|
| 129 | * or `TRANSFER_FAILED`. See [Cloud Domains feature
|
---|
| 130 | * deprecation](https://cloud.google.com/domains/docs/deprecations/feature-
|
---|
| 131 | * deprecations) for more details. (registrations.delete)
|
---|
| 132 | *
|
---|
| 133 | * @param string $name Required. The name of the `Registration` to delete, in
|
---|
| 134 | * the format `projects/locations/registrations`.
|
---|
| 135 | * @param array $optParams Optional parameters.
|
---|
| 136 | * @return Operation
|
---|
| 137 | * @throws \Google\Service\Exception
|
---|
| 138 | */
|
---|
| 139 | public function delete($name, $optParams = [])
|
---|
| 140 | {
|
---|
| 141 | $params = ['name' => $name];
|
---|
| 142 | $params = array_merge($params, $optParams);
|
---|
| 143 | return $this->call('delete', [$params], Operation::class);
|
---|
| 144 | }
|
---|
| 145 | /**
|
---|
| 146 | * Deprecated: For more information, see [Cloud Domains feature
|
---|
| 147 | * deprecation](https://cloud.google.com/domains/docs/deprecations/feature-
|
---|
| 148 | * deprecations) Exports a `Registration` resource, such that it is no longer
|
---|
| 149 | * managed by Cloud Domains. When an active domain is successfully exported, you
|
---|
| 150 | * can continue to use the domain in [Google Domains](https://domains.google/)
|
---|
| 151 | * until it expires. The calling user becomes the domain's sole owner in Google
|
---|
| 152 | * Domains, and permissions for the domain are subsequently managed there. The
|
---|
| 153 | * domain does not renew automatically unless the new owner sets up billing in
|
---|
| 154 | * Google Domains. (registrations.export)
|
---|
| 155 | *
|
---|
| 156 | * @param string $name Required. The name of the `Registration` to export, in
|
---|
| 157 | * the format `projects/locations/registrations`.
|
---|
| 158 | * @param ExportRegistrationRequest $postBody
|
---|
| 159 | * @param array $optParams Optional parameters.
|
---|
| 160 | * @return Operation
|
---|
| 161 | * @throws \Google\Service\Exception
|
---|
| 162 | */
|
---|
| 163 | public function export($name, ExportRegistrationRequest $postBody, $optParams = [])
|
---|
| 164 | {
|
---|
| 165 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
| 166 | $params = array_merge($params, $optParams);
|
---|
| 167 | return $this->call('export', [$params], Operation::class);
|
---|
| 168 | }
|
---|
| 169 | /**
|
---|
| 170 | * Gets the details of a `Registration` resource. (registrations.get)
|
---|
| 171 | *
|
---|
| 172 | * @param string $name Required. The name of the `Registration` to get, in the
|
---|
| 173 | * format `projects/locations/registrations`.
|
---|
| 174 | * @param array $optParams Optional parameters.
|
---|
| 175 | * @return Registration
|
---|
| 176 | * @throws \Google\Service\Exception
|
---|
| 177 | */
|
---|
| 178 | public function get($name, $optParams = [])
|
---|
| 179 | {
|
---|
| 180 | $params = ['name' => $name];
|
---|
| 181 | $params = array_merge($params, $optParams);
|
---|
| 182 | return $this->call('get', [$params], Registration::class);
|
---|
| 183 | }
|
---|
| 184 | /**
|
---|
| 185 | * Gets the access control policy for a resource. Returns an empty policy if the
|
---|
| 186 | * resource exists and does not have a policy set. (registrations.getIamPolicy)
|
---|
| 187 | *
|
---|
| 188 | * @param string $resource REQUIRED: The resource for which the policy is being
|
---|
| 189 | * requested. See [Resource
|
---|
| 190 | * names](https://cloud.google.com/apis/design/resource_names) for the
|
---|
| 191 | * appropriate value for this field.
|
---|
| 192 | * @param array $optParams Optional parameters.
|
---|
| 193 | *
|
---|
| 194 | * @opt_param int options.requestedPolicyVersion Optional. The maximum policy
|
---|
| 195 | * version that will be used to format the policy. Valid values are 0, 1, and 3.
|
---|
| 196 | * Requests specifying an invalid value will be rejected. Requests for policies
|
---|
| 197 | * with any conditional role bindings must specify version 3. Policies with no
|
---|
| 198 | * conditional role bindings may specify any valid value or leave the field
|
---|
| 199 | * unset. The policy in the response might use the policy version that you
|
---|
| 200 | * specified, or it might use a lower policy version. For example, if you
|
---|
| 201 | * specify version 3, but the policy has no conditional role bindings, the
|
---|
| 202 | * response uses version 1. To learn which resources support conditions in their
|
---|
| 203 | * IAM policies, see the [IAM
|
---|
| 204 | * documentation](https://cloud.google.com/iam/help/conditions/resource-
|
---|
| 205 | * policies).
|
---|
| 206 | * @return Policy
|
---|
| 207 | * @throws \Google\Service\Exception
|
---|
| 208 | */
|
---|
| 209 | public function getIamPolicy($resource, $optParams = [])
|
---|
| 210 | {
|
---|
| 211 | $params = ['resource' => $resource];
|
---|
| 212 | $params = array_merge($params, $optParams);
|
---|
| 213 | return $this->call('getIamPolicy', [$params], Policy::class);
|
---|
| 214 | }
|
---|
| 215 | /**
|
---|
| 216 | * Deprecated: For more information, see [Cloud Domains feature
|
---|
| 217 | * deprecation](https://cloud.google.com/domains/docs/deprecations/feature-
|
---|
| 218 | * deprecations) Imports a domain name from [Google
|
---|
| 219 | * Domains](https://domains.google/) for use in Cloud Domains. To transfer a
|
---|
| 220 | * domain from another registrar, use the `TransferDomain` method instead. Since
|
---|
| 221 | * individual users can own domains in Google Domains, the calling user must
|
---|
| 222 | * have ownership permission on the domain. (registrations.import)
|
---|
| 223 | *
|
---|
| 224 | * @param string $parent Required. The parent resource of the Registration. Must
|
---|
| 225 | * be in the format `projects/locations`.
|
---|
| 226 | * @param ImportDomainRequest $postBody
|
---|
| 227 | * @param array $optParams Optional parameters.
|
---|
| 228 | * @return Operation
|
---|
| 229 | * @throws \Google\Service\Exception
|
---|
| 230 | */
|
---|
| 231 | public function import($parent, ImportDomainRequest $postBody, $optParams = [])
|
---|
| 232 | {
|
---|
| 233 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
| 234 | $params = array_merge($params, $optParams);
|
---|
| 235 | return $this->call('import', [$params], Operation::class);
|
---|
| 236 | }
|
---|
| 237 | /**
|
---|
| 238 | * Initiates the `Push Transfer` process to transfer the domain to another
|
---|
| 239 | * registrar. The process might complete instantly or might require confirmation
|
---|
| 240 | * or additional work. Check the emails sent to the email address of the
|
---|
| 241 | * registrant. The process is aborted after a timeout if it's not completed.
|
---|
| 242 | * This method is only supported for domains that have the
|
---|
| 243 | * `REQUIRE_PUSH_TRANSFER` property in the list of `domain_properties`. The
|
---|
| 244 | * domain must also be unlocked before it can be transferred to a different
|
---|
| 245 | * registrar. For more information, see [Transfer a registered domain to another
|
---|
| 246 | * registrar](https://cloud.google.com/domains/docs/transfer-domain-to-another-
|
---|
| 247 | * registrar). (registrations.initiatePushTransfer)
|
---|
| 248 | *
|
---|
| 249 | * @param string $registration Required. The name of the `Registration` for
|
---|
| 250 | * which the push transfer is initiated, in the format
|
---|
| 251 | * `projects/locations/registrations`.
|
---|
| 252 | * @param InitiatePushTransferRequest $postBody
|
---|
| 253 | * @param array $optParams Optional parameters.
|
---|
| 254 | * @return Operation
|
---|
| 255 | * @throws \Google\Service\Exception
|
---|
| 256 | */
|
---|
| 257 | public function initiatePushTransfer($registration, InitiatePushTransferRequest $postBody, $optParams = [])
|
---|
| 258 | {
|
---|
| 259 | $params = ['registration' => $registration, 'postBody' => $postBody];
|
---|
| 260 | $params = array_merge($params, $optParams);
|
---|
| 261 | return $this->call('initiatePushTransfer', [$params], Operation::class);
|
---|
| 262 | }
|
---|
| 263 | /**
|
---|
| 264 | * Lists the `Registration` resources in a project.
|
---|
| 265 | * (registrations.listProjectsLocationsRegistrations)
|
---|
| 266 | *
|
---|
| 267 | * @param string $parent Required. The project and location from which to list
|
---|
| 268 | * `Registration`s, specified in the format `projects/locations`.
|
---|
| 269 | * @param array $optParams Optional parameters.
|
---|
| 270 | *
|
---|
| 271 | * @opt_param string filter Filter expression to restrict the `Registration`s
|
---|
| 272 | * returned. The expression must specify the field name, a comparison operator,
|
---|
| 273 | * and the value that you want to use for filtering. The value must be a string,
|
---|
| 274 | * a number, a boolean, or an enum value. The comparison operator should be one
|
---|
| 275 | * of =, !=, >, <, >=, <=, or : for prefix or wildcard matches. For example, to
|
---|
| 276 | * filter to a specific domain name, use an expression like
|
---|
| 277 | * `domainName="example.com"`. You can also check for the existence of a field;
|
---|
| 278 | * for example, to find domains using custom DNS settings, use an expression
|
---|
| 279 | * like `dnsSettings.customDns:*`. You can also create compound filters by
|
---|
| 280 | * combining expressions with the `AND` and `OR` operators. For example, to find
|
---|
| 281 | * domains that are suspended or have specific issues flagged, use an expression
|
---|
| 282 | * like `(state=SUSPENDED) OR (issue:*)`.
|
---|
| 283 | * @opt_param int pageSize Maximum number of results to return.
|
---|
| 284 | * @opt_param string pageToken When set to the `next_page_token` from a prior
|
---|
| 285 | * response, provides the next page of results.
|
---|
| 286 | * @return ListRegistrationsResponse
|
---|
| 287 | * @throws \Google\Service\Exception
|
---|
| 288 | */
|
---|
| 289 | public function listProjectsLocationsRegistrations($parent, $optParams = [])
|
---|
| 290 | {
|
---|
| 291 | $params = ['parent' => $parent];
|
---|
| 292 | $params = array_merge($params, $optParams);
|
---|
| 293 | return $this->call('list', [$params], ListRegistrationsResponse::class);
|
---|
| 294 | }
|
---|
| 295 | /**
|
---|
| 296 | * Updates select fields of a `Registration` resource, notably `labels`. To
|
---|
| 297 | * update other fields, use the appropriate custom update method: * To update
|
---|
| 298 | * management settings, see `ConfigureManagementSettings` * To update DNS
|
---|
| 299 | * configuration, see `ConfigureDnsSettings` * To update contact information,
|
---|
| 300 | * see `ConfigureContactSettings` (registrations.patch)
|
---|
| 301 | *
|
---|
| 302 | * @param string $name Output only. Name of the `Registration` resource, in the
|
---|
| 303 | * format `projects/locations/registrations/`.
|
---|
| 304 | * @param Registration $postBody
|
---|
| 305 | * @param array $optParams Optional parameters.
|
---|
| 306 | *
|
---|
| 307 | * @opt_param string updateMask Required. The field mask describing which fields
|
---|
| 308 | * to update as a comma-separated list. For example, if only the labels are
|
---|
| 309 | * being updated, the `update_mask` is `"labels"`.
|
---|
| 310 | * @return Operation
|
---|
| 311 | * @throws \Google\Service\Exception
|
---|
| 312 | */
|
---|
| 313 | public function patch($name, Registration $postBody, $optParams = [])
|
---|
| 314 | {
|
---|
| 315 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
| 316 | $params = array_merge($params, $optParams);
|
---|
| 317 | return $this->call('patch', [$params], Operation::class);
|
---|
| 318 | }
|
---|
| 319 | /**
|
---|
| 320 | * Registers a new domain name and creates a corresponding `Registration`
|
---|
| 321 | * resource. Call `RetrieveRegisterParameters` first to check availability of
|
---|
| 322 | * the domain name and determine parameters like price that are needed to build
|
---|
| 323 | * a call to this method. A successful call creates a `Registration` resource in
|
---|
| 324 | * state `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2 minutes,
|
---|
| 325 | * indicating that the domain was successfully registered. If the resource ends
|
---|
| 326 | * up in state `REGISTRATION_FAILED`, it indicates that the domain was not
|
---|
| 327 | * registered successfully, and you can safely delete the resource and retry
|
---|
| 328 | * registration. (registrations.register)
|
---|
| 329 | *
|
---|
| 330 | * @param string $parent Required. The parent resource of the `Registration`.
|
---|
| 331 | * Must be in the format `projects/locations`.
|
---|
| 332 | * @param RegisterDomainRequest $postBody
|
---|
| 333 | * @param array $optParams Optional parameters.
|
---|
| 334 | * @return Operation
|
---|
| 335 | * @throws \Google\Service\Exception
|
---|
| 336 | */
|
---|
| 337 | public function register($parent, RegisterDomainRequest $postBody, $optParams = [])
|
---|
| 338 | {
|
---|
| 339 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
| 340 | $params = array_merge($params, $optParams);
|
---|
| 341 | return $this->call('register', [$params], Operation::class);
|
---|
| 342 | }
|
---|
| 343 | /**
|
---|
| 344 | * Renews a recently expired domain. This method can only be called on domains
|
---|
| 345 | * that expired in the previous 30 days. After the renewal, the new expiration
|
---|
| 346 | * time of the domain is one year after the old expiration time and you are
|
---|
| 347 | * charged a `yearly_price` for the renewal. (registrations.renewDomain)
|
---|
| 348 | *
|
---|
| 349 | * @param string $registration Required. The name of the `Registration` whish is
|
---|
| 350 | * being renewed, in the format `projects/locations/registrations`.
|
---|
| 351 | * @param RenewDomainRequest $postBody
|
---|
| 352 | * @param array $optParams Optional parameters.
|
---|
| 353 | * @return Operation
|
---|
| 354 | * @throws \Google\Service\Exception
|
---|
| 355 | */
|
---|
| 356 | public function renewDomain($registration, RenewDomainRequest $postBody, $optParams = [])
|
---|
| 357 | {
|
---|
| 358 | $params = ['registration' => $registration, 'postBody' => $postBody];
|
---|
| 359 | $params = array_merge($params, $optParams);
|
---|
| 360 | return $this->call('renewDomain', [$params], Operation::class);
|
---|
| 361 | }
|
---|
| 362 | /**
|
---|
| 363 | * Resets the authorization code of the `Registration` to a new random string.
|
---|
| 364 | * You can call this method only after 60 days have elapsed since the initial
|
---|
| 365 | * domain registration. Domains that have the `REQUIRE_PUSH_TRANSFER` property
|
---|
| 366 | * in the list of `domain_properties` don't support authorization codes and must
|
---|
| 367 | * use the `InitiatePushTransfer` method to initiate the process to transfer the
|
---|
| 368 | * domain to a different registrar. (registrations.resetAuthorizationCode)
|
---|
| 369 | *
|
---|
| 370 | * @param string $registration Required. The name of the `Registration` whose
|
---|
| 371 | * authorization code is being reset, in the format
|
---|
| 372 | * `projects/locations/registrations`.
|
---|
| 373 | * @param ResetAuthorizationCodeRequest $postBody
|
---|
| 374 | * @param array $optParams Optional parameters.
|
---|
| 375 | * @return AuthorizationCode
|
---|
| 376 | * @throws \Google\Service\Exception
|
---|
| 377 | */
|
---|
| 378 | public function resetAuthorizationCode($registration, ResetAuthorizationCodeRequest $postBody, $optParams = [])
|
---|
| 379 | {
|
---|
| 380 | $params = ['registration' => $registration, 'postBody' => $postBody];
|
---|
| 381 | $params = array_merge($params, $optParams);
|
---|
| 382 | return $this->call('resetAuthorizationCode', [$params], AuthorizationCode::class);
|
---|
| 383 | }
|
---|
| 384 | /**
|
---|
| 385 | * Gets the authorization code of the `Registration` for the purpose of
|
---|
| 386 | * transferring the domain to another registrar. You can call this method only
|
---|
| 387 | * after 60 days have elapsed since the initial domain registration. Domains
|
---|
| 388 | * that have the `REQUIRE_PUSH_TRANSFER` property in the list of
|
---|
| 389 | * `domain_properties` don't support authorization codes and must use the
|
---|
| 390 | * `InitiatePushTransfer` method to initiate the process to transfer the domain
|
---|
| 391 | * to a different registrar. (registrations.retrieveAuthorizationCode)
|
---|
| 392 | *
|
---|
| 393 | * @param string $registration Required. The name of the `Registration` whose
|
---|
| 394 | * authorization code is being retrieved, in the format
|
---|
| 395 | * `projects/locations/registrations`.
|
---|
| 396 | * @param array $optParams Optional parameters.
|
---|
| 397 | * @return AuthorizationCode
|
---|
| 398 | * @throws \Google\Service\Exception
|
---|
| 399 | */
|
---|
| 400 | public function retrieveAuthorizationCode($registration, $optParams = [])
|
---|
| 401 | {
|
---|
| 402 | $params = ['registration' => $registration];
|
---|
| 403 | $params = array_merge($params, $optParams);
|
---|
| 404 | return $this->call('retrieveAuthorizationCode', [$params], AuthorizationCode::class);
|
---|
| 405 | }
|
---|
| 406 | /**
|
---|
| 407 | * Lists the DNS records from the Google Domains DNS zone for domains that use
|
---|
| 408 | * the deprecated `google_domains_dns` in the `Registration`'s `dns_settings`.
|
---|
| 409 | * (registrations.retrieveGoogleDomainsDnsRecords)
|
---|
| 410 | *
|
---|
| 411 | * @param string $registration Required. The name of the `Registration` whose
|
---|
| 412 | * Google Domains DNS records details you are retrieving, in the format
|
---|
| 413 | * `projects/locations/registrations`.
|
---|
| 414 | * @param array $optParams Optional parameters.
|
---|
| 415 | *
|
---|
| 416 | * @opt_param int pageSize Optional. Maximum number of results to return.
|
---|
| 417 | * @opt_param string pageToken Optional. When set to the `next_page_token` from
|
---|
| 418 | * a prior response, provides the next page of results.
|
---|
| 419 | * @return RetrieveGoogleDomainsDnsRecordsResponse
|
---|
| 420 | * @throws \Google\Service\Exception
|
---|
| 421 | */
|
---|
| 422 | public function retrieveGoogleDomainsDnsRecords($registration, $optParams = [])
|
---|
| 423 | {
|
---|
| 424 | $params = ['registration' => $registration];
|
---|
| 425 | $params = array_merge($params, $optParams);
|
---|
| 426 | return $this->call('retrieveGoogleDomainsDnsRecords', [$params], RetrieveGoogleDomainsDnsRecordsResponse::class);
|
---|
| 427 | }
|
---|
| 428 | /**
|
---|
| 429 | * Lists the deprecated domain and email forwarding configurations you set up in
|
---|
| 430 | * the deprecated Google Domains UI. The configuration is present only for
|
---|
| 431 | * domains with the `google_domains_redirects_data_available` set to `true` in
|
---|
| 432 | * the `Registration`'s `dns_settings`. A forwarding configuration might not
|
---|
| 433 | * work correctly if required DNS records are not present in the domain's
|
---|
| 434 | * authoritative DNS Zone. (registrations.retrieveGoogleDomainsForwardingConfig)
|
---|
| 435 | *
|
---|
| 436 | * @param string $registration Required. The name of the `Registration` whose
|
---|
| 437 | * Google Domains forwarding configuration details are being retrieved, in the
|
---|
| 438 | * format `projects/locations/registrations`.
|
---|
| 439 | * @param array $optParams Optional parameters.
|
---|
| 440 | * @return RetrieveGoogleDomainsForwardingConfigResponse
|
---|
| 441 | * @throws \Google\Service\Exception
|
---|
| 442 | */
|
---|
| 443 | public function retrieveGoogleDomainsForwardingConfig($registration, $optParams = [])
|
---|
| 444 | {
|
---|
| 445 | $params = ['registration' => $registration];
|
---|
| 446 | $params = array_merge($params, $optParams);
|
---|
| 447 | return $this->call('retrieveGoogleDomainsForwardingConfig', [$params], RetrieveGoogleDomainsForwardingConfigResponse::class);
|
---|
| 448 | }
|
---|
| 449 | /**
|
---|
| 450 | * Deprecated: For more information, see [Cloud Domains feature
|
---|
| 451 | * deprecation](https://cloud.google.com/domains/docs/deprecations/feature-
|
---|
| 452 | * deprecations) Lists domain names from [Google
|
---|
| 453 | * Domains](https://domains.google/) that can be imported to Cloud Domains using
|
---|
| 454 | * the `ImportDomain` method. Since individual users can own domains in Google
|
---|
| 455 | * Domains, the list of domains returned depends on the individual user making
|
---|
| 456 | * the call. Domains already managed by Cloud Domains are not returned.
|
---|
| 457 | * (registrations.retrieveImportableDomains)
|
---|
| 458 | *
|
---|
| 459 | * @param string $location Required. The location. Must be in the format
|
---|
| 460 | * `projects/locations`.
|
---|
| 461 | * @param array $optParams Optional parameters.
|
---|
| 462 | *
|
---|
| 463 | * @opt_param int pageSize Maximum number of results to return.
|
---|
| 464 | * @opt_param string pageToken When set to the `next_page_token` from a prior
|
---|
| 465 | * response, provides the next page of results.
|
---|
| 466 | * @return RetrieveImportableDomainsResponse
|
---|
| 467 | * @throws \Google\Service\Exception
|
---|
| 468 | */
|
---|
| 469 | public function retrieveImportableDomains($location, $optParams = [])
|
---|
| 470 | {
|
---|
| 471 | $params = ['location' => $location];
|
---|
| 472 | $params = array_merge($params, $optParams);
|
---|
| 473 | return $this->call('retrieveImportableDomains', [$params], RetrieveImportableDomainsResponse::class);
|
---|
| 474 | }
|
---|
| 475 | /**
|
---|
| 476 | * Gets parameters needed to register a new domain name, including price and up-
|
---|
| 477 | * to-date availability. Use the returned values to call `RegisterDomain`.
|
---|
| 478 | * (registrations.retrieveRegisterParameters)
|
---|
| 479 | *
|
---|
| 480 | * @param string $location Required. The location. Must be in the format
|
---|
| 481 | * `projects/locations`.
|
---|
| 482 | * @param array $optParams Optional parameters.
|
---|
| 483 | *
|
---|
| 484 | * @opt_param string domainName Required. The domain name. Unicode domain names
|
---|
| 485 | * must be expressed in Punycode format.
|
---|
| 486 | * @return RetrieveRegisterParametersResponse
|
---|
| 487 | * @throws \Google\Service\Exception
|
---|
| 488 | */
|
---|
| 489 | public function retrieveRegisterParameters($location, $optParams = [])
|
---|
| 490 | {
|
---|
| 491 | $params = ['location' => $location];
|
---|
| 492 | $params = array_merge($params, $optParams);
|
---|
| 493 | return $this->call('retrieveRegisterParameters', [$params], RetrieveRegisterParametersResponse::class);
|
---|
| 494 | }
|
---|
| 495 | /**
|
---|
| 496 | * Deprecated: For more information, see [Cloud Domains feature
|
---|
| 497 | * deprecation](https://cloud.google.com/domains/docs/deprecations/feature-
|
---|
| 498 | * deprecations) Gets parameters needed to transfer a domain name from another
|
---|
| 499 | * registrar to Cloud Domains. For domains already managed by [Google
|
---|
| 500 | * Domains](https://domains.google/), use `ImportDomain` instead. Use the
|
---|
| 501 | * returned values to call `TransferDomain`.
|
---|
| 502 | * (registrations.retrieveTransferParameters)
|
---|
| 503 | *
|
---|
| 504 | * @param string $location Required. The location. Must be in the format
|
---|
| 505 | * `projects/locations`.
|
---|
| 506 | * @param array $optParams Optional parameters.
|
---|
| 507 | *
|
---|
| 508 | * @opt_param string domainName Required. The domain name. Unicode domain names
|
---|
| 509 | * must be expressed in Punycode format.
|
---|
| 510 | * @return RetrieveTransferParametersResponse
|
---|
| 511 | * @throws \Google\Service\Exception
|
---|
| 512 | */
|
---|
| 513 | public function retrieveTransferParameters($location, $optParams = [])
|
---|
| 514 | {
|
---|
| 515 | $params = ['location' => $location];
|
---|
| 516 | $params = array_merge($params, $optParams);
|
---|
| 517 | return $this->call('retrieveTransferParameters', [$params], RetrieveTransferParametersResponse::class);
|
---|
| 518 | }
|
---|
| 519 | /**
|
---|
| 520 | * Searches for available domain names similar to the provided query.
|
---|
| 521 | * Availability results from this method are approximate; call
|
---|
| 522 | * `RetrieveRegisterParameters` on a domain before registering to confirm
|
---|
| 523 | * availability. (registrations.searchDomains)
|
---|
| 524 | *
|
---|
| 525 | * @param string $location Required. The location. Must be in the format
|
---|
| 526 | * `projects/locations`.
|
---|
| 527 | * @param array $optParams Optional parameters.
|
---|
| 528 | *
|
---|
| 529 | * @opt_param string query Required. String used to search for available domain
|
---|
| 530 | * names.
|
---|
| 531 | * @return SearchDomainsResponse
|
---|
| 532 | * @throws \Google\Service\Exception
|
---|
| 533 | */
|
---|
| 534 | public function searchDomains($location, $optParams = [])
|
---|
| 535 | {
|
---|
| 536 | $params = ['location' => $location];
|
---|
| 537 | $params = array_merge($params, $optParams);
|
---|
| 538 | return $this->call('searchDomains', [$params], SearchDomainsResponse::class);
|
---|
| 539 | }
|
---|
| 540 | /**
|
---|
| 541 | * Sets the access control policy on the specified resource. Replaces any
|
---|
| 542 | * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
|
---|
| 543 | * `PERMISSION_DENIED` errors. (registrations.setIamPolicy)
|
---|
| 544 | *
|
---|
| 545 | * @param string $resource REQUIRED: The resource for which the policy is being
|
---|
| 546 | * specified. See [Resource
|
---|
| 547 | * names](https://cloud.google.com/apis/design/resource_names) for the
|
---|
| 548 | * appropriate value for this field.
|
---|
| 549 | * @param SetIamPolicyRequest $postBody
|
---|
| 550 | * @param array $optParams Optional parameters.
|
---|
| 551 | * @return Policy
|
---|
| 552 | * @throws \Google\Service\Exception
|
---|
| 553 | */
|
---|
| 554 | public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
|
---|
| 555 | {
|
---|
| 556 | $params = ['resource' => $resource, 'postBody' => $postBody];
|
---|
| 557 | $params = array_merge($params, $optParams);
|
---|
| 558 | return $this->call('setIamPolicy', [$params], Policy::class);
|
---|
| 559 | }
|
---|
| 560 | /**
|
---|
| 561 | * Returns permissions that a caller has on the specified resource. If the
|
---|
| 562 | * resource does not exist, this will return an empty set of permissions, not a
|
---|
| 563 | * `NOT_FOUND` error. Note: This operation is designed to be used for building
|
---|
| 564 | * permission-aware UIs and command-line tools, not for authorization checking.
|
---|
| 565 | * This operation may "fail open" without warning.
|
---|
| 566 | * (registrations.testIamPermissions)
|
---|
| 567 | *
|
---|
| 568 | * @param string $resource REQUIRED: The resource for which the policy detail is
|
---|
| 569 | * being requested. See [Resource
|
---|
| 570 | * names](https://cloud.google.com/apis/design/resource_names) for the
|
---|
| 571 | * appropriate value for this field.
|
---|
| 572 | * @param TestIamPermissionsRequest $postBody
|
---|
| 573 | * @param array $optParams Optional parameters.
|
---|
| 574 | * @return TestIamPermissionsResponse
|
---|
| 575 | * @throws \Google\Service\Exception
|
---|
| 576 | */
|
---|
| 577 | public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
|
---|
| 578 | {
|
---|
| 579 | $params = ['resource' => $resource, 'postBody' => $postBody];
|
---|
| 580 | $params = array_merge($params, $optParams);
|
---|
| 581 | return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
|
---|
| 582 | }
|
---|
| 583 | /**
|
---|
| 584 | * Deprecated: For more information, see [Cloud Domains feature
|
---|
| 585 | * deprecation](https://cloud.google.com/domains/docs/deprecations/feature-
|
---|
| 586 | * deprecations) Transfers a domain name from another registrar to Cloud
|
---|
| 587 | * Domains. For domains already managed by [Google
|
---|
| 588 | * Domains](https://domains.google/), use `ImportDomain` instead. Before calling
|
---|
| 589 | * this method, go to the domain's current registrar to unlock the domain for
|
---|
| 590 | * transfer and retrieve the domain's transfer authorization code. Then call
|
---|
| 591 | * `RetrieveTransferParameters` to confirm that the domain is unlocked and to
|
---|
| 592 | * get values needed to build a call to this method. A successful call creates a
|
---|
| 593 | * `Registration` resource in state `TRANSFER_PENDING`. It can take several days
|
---|
| 594 | * to complete the transfer process. The registrant can often speed up this
|
---|
| 595 | * process by approving the transfer through the current registrar, either by
|
---|
| 596 | * clicking a link in an email from the registrar or by visiting the registrar's
|
---|
| 597 | * website. A few minutes after transfer approval, the resource transitions to
|
---|
| 598 | * state `ACTIVE`, indicating that the transfer was successful. If the transfer
|
---|
| 599 | * is rejected or the request expires without being approved, the resource can
|
---|
| 600 | * end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete
|
---|
| 601 | * the resource and retry the transfer. (registrations.transfer)
|
---|
| 602 | *
|
---|
| 603 | * @param string $parent Required. The parent resource of the `Registration`.
|
---|
| 604 | * Must be in the format `projects/locations`.
|
---|
| 605 | * @param TransferDomainRequest $postBody
|
---|
| 606 | * @param array $optParams Optional parameters.
|
---|
| 607 | * @return Operation
|
---|
| 608 | * @throws \Google\Service\Exception
|
---|
| 609 | */
|
---|
| 610 | public function transfer($parent, TransferDomainRequest $postBody, $optParams = [])
|
---|
| 611 | {
|
---|
| 612 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
| 613 | $params = array_merge($params, $optParams);
|
---|
| 614 | return $this->call('transfer', [$params], Operation::class);
|
---|
| 615 | }
|
---|
| 616 | }
|
---|
| 617 |
|
---|
| 618 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 619 | class_alias(ProjectsLocationsRegistrations::class, 'Google_Service_CloudDomains_Resource_ProjectsLocationsRegistrations');
|
---|