happygapi.servicemanagement.services
Service Management API: services. Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers. See: https://cloud.google.com/service-management/api/reference/rest/v1/services
Service Management API: services. Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers. See: https://cloud.google.com/service-management/api/reference/rest/v1/services
configs-create$clj
(configs-create$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/configs/create
Required parameters: serviceName
Optional parameters: none
Body:
{:monitoring {:producerDestinations [MonitoringDestination], :consumerDestinations [MonitoringDestination]}, :systemParameters {:rules [SystemParameterRule]}, :logs [{:name string, :description string, :displayName string, :labels [LabelDescriptor]}], :name string, :billing {:consumerDestinations [BillingDestination]}, :producerProjectId string, :quota {:limits [QuotaLimit], :metricRules [MetricRule]}, :title string, :documentation {:summary string, :overview string, :pages [Page], :serviceRootUrl string, :documentationRootUrl string, :rules [DocumentationRule]}, :types [{:options [Option], :fields [Field], :name string, :oneofs [string], :syntax string, :sourceContext SourceContext}], :logging {:consumerDestinations [LoggingDestination], :producerDestinations [LoggingDestination]}, :endpoints [{:name string, :target string, :aliases [string], :features [string], :allowCors boolean}], :configVersion integer, :sourceInfo {:sourceFiles [{}]}, :usage {:producerNotificationChannel string, :rules [UsageRule], :serviceIdentity ServiceIdentity, :requirements [string]}, :authentication {:rules [AuthenticationRule], :providers [AuthProvider]}, :id string, :control {:environment string}, :http {:rules [HttpRule], :fullyDecodeReservedExpansion boolean}, :context {:rules [ContextRule]}, :monitoredResources [{:displayName string, :description string, :labels [LabelDescriptor], :launchStage string, :name string, :type string}], :apis [{:methods [Method], :name string, :syntax string, :sourceContext SourceContext, :version string, :mixins [Mixin], :options [Option]}], :customError {:types [string], :rules [CustomErrorRule]}, :systemTypes [{:options [Option], :fields [Field], :name string, :oneofs [string], :syntax string, :sourceContext SourceContext}], :enums [{:name string, :enumvalue [EnumValue], :options [Option], :sourceContext SourceContext, :syntax string}], :backend {:rules [BackendRule]}, :metrics [{:description string, :labels [LabelDescriptor], :valueType string, :monitoredResourceTypes [string], :unit string, :displayName string, :name string, :type string, :metricKind string, :launchStage string, :metadata MetricDescriptorMetadata}]}
Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout.
Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.
https://cloud.google.com/service-management/api/reference/rest/v1/services/configs/create
Required parameters: serviceName
Optional parameters: none
Body:
{:monitoring {:producerDestinations [MonitoringDestination],
:consumerDestinations [MonitoringDestination]},
:systemParameters {:rules [SystemParameterRule]},
:logs [{:name string,
:description string,
:displayName string,
:labels [LabelDescriptor]}],
:name string,
:billing {:consumerDestinations [BillingDestination]},
:producerProjectId string,
:quota {:limits [QuotaLimit], :metricRules [MetricRule]},
:title string,
:documentation {:summary string,
:overview string,
:pages [Page],
:serviceRootUrl string,
:documentationRootUrl string,
:rules [DocumentationRule]},
:types [{:options [Option],
:fields [Field],
:name string,
:oneofs [string],
:syntax string,
:sourceContext SourceContext}],
:logging {:consumerDestinations [LoggingDestination],
:producerDestinations [LoggingDestination]},
:endpoints [{:name string,
:target string,
:aliases [string],
:features [string],
:allowCors boolean}],
:configVersion integer,
:sourceInfo {:sourceFiles [{}]},
:usage {:producerNotificationChannel string,
:rules [UsageRule],
:serviceIdentity ServiceIdentity,
:requirements [string]},
:authentication {:rules [AuthenticationRule],
:providers [AuthProvider]},
:id string,
:control {:environment string},
:http {:rules [HttpRule], :fullyDecodeReservedExpansion boolean},
:context {:rules [ContextRule]},
:monitoredResources [{:displayName string,
:description string,
:labels [LabelDescriptor],
:launchStage string,
:name string,
:type string}],
:apis [{:methods [Method],
:name string,
:syntax string,
:sourceContext SourceContext,
:version string,
:mixins [Mixin],
:options [Option]}],
:customError {:types [string], :rules [CustomErrorRule]},
:systemTypes [{:options [Option],
:fields [Field],
:name string,
:oneofs [string],
:syntax string,
:sourceContext SourceContext}],
:enums [{:name string,
:enumvalue [EnumValue],
:options [Option],
:sourceContext SourceContext,
:syntax string}],
:backend {:rules [BackendRule]},
:metrics [{:description string,
:labels [LabelDescriptor],
:valueType string,
:monitoredResourceTypes [string],
:unit string,
:displayName string,
:name string,
:type string,
:metricKind string,
:launchStage string,
:metadata MetricDescriptorMetadata}]}
Creates a new service configuration (version) for a managed service.
This method only stores the service configuration. To roll out the service
configuration to backend systems please call
CreateServiceRollout.
Only the 100 most recent service configurations and ones referenced by
existing rollouts are kept for each service. The rest will be deleted
eventually.configs-get$clj
(configs-get$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/configs/get
Required parameters: serviceName, configId
Optional parameters: view
Gets a service configuration (version) for a managed service.
https://cloud.google.com/service-management/api/reference/rest/v1/services/configs/get Required parameters: serviceName, configId Optional parameters: view Gets a service configuration (version) for a managed service.
configs-list$clj
(configs-list$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/configs/list
Required parameters: serviceName
Optional parameters: pageToken, pageSize
Lists the history of the service configuration for a managed service, from the newest to the oldest.
https://cloud.google.com/service-management/api/reference/rest/v1/services/configs/list Required parameters: serviceName Optional parameters: pageToken, pageSize Lists the history of the service configuration for a managed service, from the newest to the oldest.
configs-submit$clj
(configs-submit$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/configs/submit
Required parameters: serviceName
Optional parameters: none
Body:
{:validateOnly boolean, :configSource {:id string, :files [ConfigFile]}}
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout.
Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.
Operation<response: SubmitConfigSourceResponse>
https://cloud.google.com/service-management/api/reference/rest/v1/services/configs/submit
Required parameters: serviceName
Optional parameters: none
Body:
{:validateOnly boolean,
:configSource {:id string, :files [ConfigFile]}}
Creates a new service configuration (version) for a managed service based
on
user-supplied configuration source files (for example: OpenAPI
Specification). This method stores the source configurations as well as the
generated service configuration. To rollout the service configuration to
other services,
please call CreateServiceRollout.
Only the 100 most recent configuration sources and ones referenced by
existing service configurtions are kept for each service. The rest will be
deleted eventually.
Operation<response: SubmitConfigSourceResponse>consumers-getIamPolicy$clj
(consumers-getIamPolicy$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/consumers/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
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/service-management/api/reference/rest/v1/services/consumers/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
set.consumers-setIamPolicy$clj
(consumers-setIamPolicy$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/consumers/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:bindings [Binding], :etag string, :version integer, :auditConfigs [AuditConfig]}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
https://cloud.google.com/service-management/api/reference/rest/v1/services/consumers/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:bindings [Binding],
:etag string,
:version integer,
:auditConfigs [AuditConfig]},
:updateMask string}
Sets the access control policy on the specified resource. Replaces any
existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIEDconsumers-testIamPermissions$clj
(consumers-testIamPermissions$ auth parameters body)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/service-management/api/reference/rest/v1/services/consumers/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.create$clj
(create$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/create
Required parameters: none
Optional parameters: none
Body:
{:producerProjectId string, :serviceName string}
Creates a new managed service. Please note one producer project can own no more than 20 services.
Operation<response: ManagedService>
https://cloud.google.com/service-management/api/reference/rest/v1/services/create
Required parameters: none
Optional parameters: none
Body:
{:producerProjectId string, :serviceName string}
Creates a new managed service.
Please note one producer project can own no more than 20 services.
Operation<response: ManagedService>delete$clj
(delete$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/delete
Required parameters: serviceName
Optional parameters: none
Deletes a managed service. This method will change the service to the
Soft-Delete state for 30 days. Within this period, service producers may
call UndeleteService to restore the service.
After 30 days, the service will be permanently deleted.
Operation<response: google.protobuf.Empty>
https://cloud.google.com/service-management/api/reference/rest/v1/services/delete Required parameters: serviceName Optional parameters: none Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted. Operation<response: google.protobuf.Empty>
disable$clj
(disable$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/disable
Required parameters: serviceName
Optional parameters: none
Body:
{:consumerId string}
Disables a service for a project, so it can no longer be be used for the project. It prevents accidental usage that may cause unexpected billing charges or security leaks.
Operation<response: DisableServiceResponse>
https://cloud.google.com/service-management/api/reference/rest/v1/services/disable
Required parameters: serviceName
Optional parameters: none
Body:
{:consumerId string}
Disables a service for a project, so it can no longer be
be used for the project. It prevents accidental usage that may cause
unexpected billing charges or security leaks.
Operation<response: DisableServiceResponse>enable$clj
(enable$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/enable
Required parameters: serviceName
Optional parameters: none
Body:
{:consumerId string}
Enables a service for a project, so it can be used for the project. See Cloud Auth Guide for more information.
Operation<response: EnableServiceResponse>
https://cloud.google.com/service-management/api/reference/rest/v1/services/enable
Required parameters: serviceName
Optional parameters: none
Body:
{:consumerId string}
Enables a service for a project, so it can be used
for the project. See
[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
more information.
Operation<response: EnableServiceResponse>generateConfigReport$clj
(generateConfigReport$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/generateConfigReport
Required parameters: none
Optional parameters: none
Body:
{:oldConfig {}, :newConfig {}}
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value
If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.
https://cloud.google.com/service-management/api/reference/rest/v1/services/generateConfigReport
Required parameters: none
Optional parameters: none
Body:
{:oldConfig {}, :newConfig {}}
Generates and returns a report (errors, warnings and changes from
existing configurations) associated with
GenerateConfigReportRequest.new_value
If GenerateConfigReportRequest.old_value is specified,
GenerateConfigReportRequest will contain a single ChangeReport based on the
comparison between GenerateConfigReportRequest.new_value and
GenerateConfigReportRequest.old_value.
If GenerateConfigReportRequest.old_value is not specified, this method
will compare GenerateConfigReportRequest.new_value with the last pushed
service configuration.get$clj
(get$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/get
Required parameters: serviceName
Optional parameters: none
Gets a managed service. Authentication is required unless the service is public.
https://cloud.google.com/service-management/api/reference/rest/v1/services/get Required parameters: serviceName Optional parameters: none Gets a managed service. Authentication is required unless the service is public.
getConfig$clj
(getConfig$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/getConfig
Required parameters: serviceName
Optional parameters: configId, view
Gets a service configuration (version) for a managed service.
https://cloud.google.com/service-management/api/reference/rest/v1/services/getConfig Required parameters: serviceName Optional parameters: configId, view Gets a service configuration (version) for a managed service.
getIamPolicy$clj
(getIamPolicy$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
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/service-management/api/reference/rest/v1/services/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy
set.list$clj
(list$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/list
Required parameters: none
Optional parameters: consumerId, pageToken, pageSize, producerProjectId
Lists managed services.
Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.
BETA: If the caller specifies the consumer_id, it returns only the
services enabled on the consumer. The consumer_id must have the format
of "project:{PROJECT-ID}".
https://cloud.google.com/service-management/api/reference/rest/v1/services/list
Required parameters: none
Optional parameters: consumerId, pageToken, pageSize, producerProjectId
Lists managed services.
Returns all public services. For authenticated users, also returns all
services the calling user has "servicemanagement.services.get" permission
for.
**BETA:** If the caller specifies the `consumer_id`, it returns only the
services enabled on the consumer. The `consumer_id` must have the format
of "project:{PROJECT-ID}".rollouts-create$clj
(rollouts-create$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/rollouts/create
Required parameters: serviceName
Optional parameters: none
Body:
{:rolloutId string, :deleteServiceStrategy {}, :createTime string, :status string, :serviceName string, :trafficPercentStrategy {:percentages {}}, :createdBy string}
Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.
Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.
Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.
Operation<response: Rollout>
https://cloud.google.com/service-management/api/reference/rest/v1/services/rollouts/create
Required parameters: serviceName
Optional parameters: none
Body:
{:rolloutId string,
:deleteServiceStrategy {},
:createTime string,
:status string,
:serviceName string,
:trafficPercentStrategy {:percentages {}},
:createdBy string}
Creates a new service configuration rollout. Based on rollout, the
Google Service Management will roll out the service configurations to
different backend services. For example, the logging configuration will be
pushed to Google Cloud Logging.
Please note that any previous pending and running Rollouts and associated
Operations will be automatically cancelled so that the latest Rollout will
not be blocked by previous Rollouts.
Only the 100 most recent (in any state) and the last 10 successful (if not
already part of the set of 100 most recent) rollouts are kept for each
service. The rest will be deleted eventually.
Operation<response: Rollout>rollouts-get$clj
(rollouts-get$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/rollouts/get
Required parameters: serviceName, rolloutId
Optional parameters: none
Gets a service configuration rollout.
https://cloud.google.com/service-management/api/reference/rest/v1/services/rollouts/get Required parameters: serviceName, rolloutId Optional parameters: none Gets a service configuration rollout.
rollouts-list$clj
(rollouts-list$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/rollouts/list
Required parameters: serviceName
Optional parameters: filter, pageToken, pageSize
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
https://cloud.google.com/service-management/api/reference/rest/v1/services/rollouts/list Required parameters: serviceName Optional parameters: filter, pageToken, pageSize Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
setIamPolicy$clj
(setIamPolicy$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:bindings [Binding], :etag string, :version integer, :auditConfigs [AuditConfig]}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
https://cloud.google.com/service-management/api/reference/rest/v1/services/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:bindings [Binding],
:etag string,
:version integer,
:auditConfigs [AuditConfig]},
:updateMask string}
Sets the access control policy on the specified resource. Replaces any
existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIEDtestIamPermissions$clj
(testIamPermissions$ auth parameters body)https://cloud.google.com/service-management/api/reference/rest/v1/services/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/service-management/api/reference/rest/v1/services/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.undelete$clj
(undelete$ auth parameters)https://cloud.google.com/service-management/api/reference/rest/v1/services/undelete
Required parameters: serviceName
Optional parameters: none
Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.
Operation<response: UndeleteServiceResponse>
https://cloud.google.com/service-management/api/reference/rest/v1/services/undelete Required parameters: serviceName Optional parameters: none Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days. Operation<response: UndeleteServiceResponse>
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close