GOgoogle
projects

PATCH /v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances/{apiHubInstancesId}

Changed on

Update an Api Hub instance. The following fields in the ApiHubInstance can be updated: * disable_search * vertex_location * agent_registry_sync_config The update_mask should be used to specify the fields being updated.

Request

  • Base URL
    https://apihub.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/apihub.readwrite
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/apihub.readwrite
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required
locationsIdstring required
apiHubInstancesIdstring required

Query parameters

updateMaskstring google-fieldmask

Optional. The list of fields to update.

Request body

createTimestring google-datetime

Output only. Creation timestamp.

descriptionstring

Optional. Description of the ApiHub instance.

labelsobject

Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

namestring

Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.

state'STATE_UNSPECIFIED' | 'INACTIVE' | 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' | 'FAILED'

Output only. The current state of the ApiHub instance.

stateMessagestring

Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED.

updateTimestring google-datetime

Output only. Last update timestamp.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

  • 09b6c7d2247bRevision changes
    • info

      the security scope https://www.googleapis.com/auth/apihub.readwrite was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/apihub.readwrite was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c