Liking cljdoc? Tell your friends :D

happygapi.apigateway.projects

API Gateway API: projects.

See: https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects
raw docstring

locations-apis-configs-create$clj

(locations-apis-configs-create$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/create

Required parameters: parent

Optional parameters: apiConfigId

Body:

{:serviceConfigId string, :labels {}, :displayName string, :name string, :grpcServices [{:source [ApigatewayApiConfigFile], :fileDescriptorSet ApigatewayApiConfigFile}], :createTime string, :state string, :managedServiceConfigs [{:contents string, :path string}], :updateTime string, :openapiDocuments [{:document ApigatewayApiConfigFile}], :gatewayServiceAccount string}

Creates a new ApiConfig in a given project and location.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/create

Required parameters: parent

Optional parameters: apiConfigId

Body: 

{:serviceConfigId string,
 :labels {},
 :displayName string,
 :name string,
 :grpcServices [{:source [ApigatewayApiConfigFile],
                 :fileDescriptorSet ApigatewayApiConfigFile}],
 :createTime string,
 :state string,
 :managedServiceConfigs [{:contents string, :path string}],
 :updateTime string,
 :openapiDocuments [{:document ApigatewayApiConfigFile}],
 :gatewayServiceAccount string}

Creates a new ApiConfig in a given project and location.
sourceraw docstring

locations-apis-configs-delete$clj

(locations-apis-configs-delete$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/delete

Required parameters: name

Optional parameters: none

Deletes a single ApiConfig.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/delete

Required parameters: name

Optional parameters: none

Deletes a single ApiConfig.
sourceraw docstring

locations-apis-configs-get$clj

(locations-apis-configs-get$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/get

Required parameters: name

Optional parameters: view

Gets details of a single ApiConfig.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/get

Required parameters: name

Optional parameters: view

Gets details of a single ApiConfig.
sourceraw docstring

locations-apis-configs-getIamPolicy$clj

(locations-apis-configs-getIamPolicy$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
sourceraw docstring

locations-apis-configs-list$clj

(locations-apis-configs-list$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/list

Required parameters: parent

Optional parameters: orderBy, pageSize, filter, pageToken

Lists ApiConfigs in a given project and location.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/list

Required parameters: parent

Optional parameters: orderBy, pageSize, filter, pageToken

Lists ApiConfigs in a given project and location.
sourceraw docstring

locations-apis-configs-patch$clj

(locations-apis-configs-patch$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:serviceConfigId string, :labels {}, :displayName string, :name string, :grpcServices [{:source [ApigatewayApiConfigFile], :fileDescriptorSet ApigatewayApiConfigFile}], :createTime string, :state string, :managedServiceConfigs [{:contents string, :path string}], :updateTime string, :openapiDocuments [{:document ApigatewayApiConfigFile}], :gatewayServiceAccount string}

Updates the parameters of a single ApiConfig.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/patch

Required parameters: name

Optional parameters: updateMask

Body: 

{:serviceConfigId string,
 :labels {},
 :displayName string,
 :name string,
 :grpcServices [{:source [ApigatewayApiConfigFile],
                 :fileDescriptorSet ApigatewayApiConfigFile}],
 :createTime string,
 :state string,
 :managedServiceConfigs [{:contents string, :path string}],
 :updateTime string,
 :openapiDocuments [{:document ApigatewayApiConfigFile}],
 :gatewayServiceAccount string}

Updates the parameters of a single ApiConfig.
sourceraw docstring

locations-apis-configs-setIamPolicy$clj

(locations-apis-configs-setIamPolicy$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:etag string, :version integer, :auditConfigs [ApigatewayAuditConfig], :bindings [ApigatewayBinding]}, :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/setIamPolicy

Required parameters: resource

Optional parameters: none

Body: 

{:policy {:etag string,
          :version integer,
          :auditConfigs [ApigatewayAuditConfig],
          :bindings [ApigatewayBinding]},
 :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
sourceraw docstring

locations-apis-configs-testIamPermissions$clj

(locations-apis-configs-testIamPermissions$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/configs/testIamPermissions

Required parameters: resource

Optional parameters: none

Body: 

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
sourceraw docstring

locations-apis-create$clj

(locations-apis-create$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/create

Required parameters: parent

Optional parameters: apiId

Body:

{:state string, :displayName string, :name string, :updateTime string, :managedService string, :labels {}, :createTime string}

Creates a new Api in a given project and location.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/create

Required parameters: parent

Optional parameters: apiId

Body: 

{:state string,
 :displayName string,
 :name string,
 :updateTime string,
 :managedService string,
 :labels {},
 :createTime string}

Creates a new Api in a given project and location.
sourceraw docstring

locations-apis-delete$clj

(locations-apis-delete$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/delete

Required parameters: name

Optional parameters: none

Deletes a single Api.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/delete

Required parameters: name

Optional parameters: none

Deletes a single Api.
sourceraw docstring

locations-apis-get$clj

(locations-apis-get$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/get

Required parameters: name

Optional parameters: none

Gets details of a single Api.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/get

Required parameters: name

Optional parameters: none

Gets details of a single Api.
sourceraw docstring

locations-apis-getIamPolicy$clj

(locations-apis-getIamPolicy$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
sourceraw docstring

locations-apis-list$clj

(locations-apis-list$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/list

Required parameters: parent

Optional parameters: orderBy, pageSize, filter, pageToken

Lists Apis in a given project and location.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/list

Required parameters: parent

Optional parameters: orderBy, pageSize, filter, pageToken

Lists Apis in a given project and location.
sourceraw docstring

locations-apis-patch$clj

(locations-apis-patch$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:state string, :displayName string, :name string, :updateTime string, :managedService string, :labels {}, :createTime string}

Updates the parameters of a single Api.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/patch

Required parameters: name

Optional parameters: updateMask

Body: 

{:state string,
 :displayName string,
 :name string,
 :updateTime string,
 :managedService string,
 :labels {},
 :createTime string}

Updates the parameters of a single Api.
sourceraw docstring

locations-apis-setIamPolicy$clj

(locations-apis-setIamPolicy$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:etag string, :version integer, :auditConfigs [ApigatewayAuditConfig], :bindings [ApigatewayBinding]}, :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/setIamPolicy

Required parameters: resource

Optional parameters: none

Body: 

{:policy {:etag string,
          :version integer,
          :auditConfigs [ApigatewayAuditConfig],
          :bindings [ApigatewayBinding]},
 :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
sourceraw docstring

locations-apis-testIamPermissions$clj

(locations-apis-testIamPermissions$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/apis/testIamPermissions

Required parameters: resource

Optional parameters: none

Body: 

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
sourceraw docstring

locations-gateways-create$clj

(locations-gateways-create$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/create

Required parameters: parent

Optional parameters: gatewayId

Body:

{:createTime string, :labels {}, :apiConfig string, :displayName string, :state string, :name string, :updateTime string, :defaultHostname string}

Creates a new Gateway in a given project and location.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/create

Required parameters: parent

Optional parameters: gatewayId

Body: 

{:createTime string,
 :labels {},
 :apiConfig string,
 :displayName string,
 :state string,
 :name string,
 :updateTime string,
 :defaultHostname string}

Creates a new Gateway in a given project and location.
sourceraw docstring

locations-gateways-delete$clj

(locations-gateways-delete$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/delete

Required parameters: name

Optional parameters: none

Deletes a single Gateway.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/delete

Required parameters: name

Optional parameters: none

Deletes a single Gateway.
sourceraw docstring

locations-gateways-get$clj

(locations-gateways-get$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/get

Required parameters: name

Optional parameters: none

Gets details of a single Gateway.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/get

Required parameters: name

Optional parameters: none

Gets details of a single Gateway.
sourceraw docstring

locations-gateways-getIamPolicy$clj

(locations-gateways-getIamPolicy$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/getIamPolicy

Required parameters: resource

Optional parameters: options.requestedPolicyVersion

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
sourceraw docstring

locations-gateways-list$clj

(locations-gateways-list$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/list

Required parameters: parent

Optional parameters: orderBy, pageSize, pageToken, filter

Lists Gateways in a given project and location.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/list

Required parameters: parent

Optional parameters: orderBy, pageSize, pageToken, filter

Lists Gateways in a given project and location.
sourceraw docstring

locations-gateways-patch$clj

(locations-gateways-patch$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:createTime string, :labels {}, :apiConfig string, :displayName string, :state string, :name string, :updateTime string, :defaultHostname string}

Updates the parameters of a single Gateway.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/patch

Required parameters: name

Optional parameters: updateMask

Body: 

{:createTime string,
 :labels {},
 :apiConfig string,
 :displayName string,
 :state string,
 :name string,
 :updateTime string,
 :defaultHostname string}

Updates the parameters of a single Gateway.
sourceraw docstring

locations-gateways-setIamPolicy$clj

(locations-gateways-setIamPolicy$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:etag string, :version integer, :auditConfigs [ApigatewayAuditConfig], :bindings [ApigatewayBinding]}, :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/setIamPolicy

Required parameters: resource

Optional parameters: none

Body: 

{:policy {:etag string,
          :version integer,
          :auditConfigs [ApigatewayAuditConfig],
          :bindings [ApigatewayBinding]},
 :updateMask string}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
sourceraw docstring

locations-gateways-testIamPermissions$clj

(locations-gateways-testIamPermissions$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/gateways/testIamPermissions

Required parameters: resource

Optional parameters: none

Body: 

{:permissions [string]}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
sourceraw docstring

locations-get$clj

(locations-get$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.
sourceraw docstring

locations-list$clj

(locations-list$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize

Lists information about the supported locations for this service.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize

Lists information about the supported locations for this service.
sourceraw docstring

locations-operations-cancel$clj

(locations-operations-cancel$ auth parameters body)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/operations/cancel

Required parameters: name

Optional parameters: none

Body:

{}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/operations/cancel

Required parameters: name

Optional parameters: none

Body: 

{}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
sourceraw docstring

locations-operations-delete$clj

(locations-operations-delete$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/operations/delete

Required parameters: name

Optional parameters: none

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/operations/delete

Required parameters: name

Optional parameters: none

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
sourceraw docstring

locations-operations-get$clj

(locations-operations-get$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
sourceraw docstring

locations-operations-list$clj

(locations-operations-list$ auth parameters)

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/operations/list

Required parameters: name

Optional parameters: pageSize, pageToken, filter

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

https://cloud.google.com/api-gateway/docsapi/reference/rest/v1/projects/locations/operations/list

Required parameters: name

Optional parameters: pageSize, pageToken, filter

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close