1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
// This file is @generated by prost-build.
/// A service that is available for use by the consumer.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Service {
/// The resource name of the consumer and service.
///
/// A valid name would be:
/// - projects/123/services/serviceusage.googleapis.com
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The resource name of the consumer.
///
/// A valid name would be:
/// - projects/123
#[prost(string, tag = "5")]
pub parent: ::prost::alloc::string::String,
/// The service configuration of the available service.
/// Some fields may be filtered out of the configuration in responses to
/// the `ListServices` method. These fields are present only in responses to
/// the `GetService` method.
#[prost(message, optional, tag = "2")]
pub config: ::core::option::Option<ServiceConfig>,
/// Whether or not the service has been enabled for use by the consumer.
#[prost(enumeration = "State", tag = "4")]
pub state: i32,
}
/// The configuration of the service.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ServiceConfig {
/// The DNS address at which this service is available.
///
/// An example DNS address would be:
/// `calendar.googleapis.com`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The product title for this service.
#[prost(string, tag = "2")]
pub title: ::prost::alloc::string::String,
/// A list of API interfaces exported by this service. Contains only the names,
/// versions, and method names of the interfaces.
#[prost(message, repeated, tag = "3")]
pub apis: ::prost::alloc::vec::Vec<::prost_types::Api>,
/// Additional API documentation. Contains only the summary and the
/// documentation URL.
#[prost(message, optional, tag = "6")]
pub documentation: ::core::option::Option<super::super::Documentation>,
/// Quota configuration.
#[prost(message, optional, tag = "10")]
pub quota: ::core::option::Option<super::super::Quota>,
/// Auth configuration. Contains only the OAuth rules.
#[prost(message, optional, tag = "11")]
pub authentication: ::core::option::Option<super::super::Authentication>,
/// Configuration controlling usage of this service.
#[prost(message, optional, tag = "15")]
pub usage: ::core::option::Option<super::super::Usage>,
/// Configuration for network endpoints. Contains only the names and aliases
/// of the endpoints.
#[prost(message, repeated, tag = "18")]
pub endpoints: ::prost::alloc::vec::Vec<super::super::Endpoint>,
/// Defines the monitored resources used by this service. This is required
/// by the [Service.monitoring][google.api.Service.monitoring] and
/// [Service.logging][google.api.Service.logging] configurations.
#[prost(message, repeated, tag = "25")]
pub monitored_resources: ::prost::alloc::vec::Vec<
super::super::MonitoredResourceDescriptor,
>,
/// Monitoring configuration.
/// This should not include the 'producer_destinations' field.
#[prost(message, optional, tag = "28")]
pub monitoring: ::core::option::Option<super::super::Monitoring>,
}
/// The operation metadata returned for the batchend services operation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OperationMetadata {
/// The full name of the resources that this operation is directly
/// associated with.
#[prost(string, repeated, tag = "2")]
pub resource_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Whether or not a service has been enabled for use by a consumer.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum State {
/// The default value, which indicates that the enabled state of the service
/// is unspecified or not meaningful. Currently, all consumers other than
/// projects (such as folders and organizations) are always in this state.
Unspecified = 0,
/// The service cannot be used by this consumer. It has either been explicitly
/// disabled, or has never been enabled.
Disabled = 1,
/// The service has been explicitly enabled for use by this consumer.
Enabled = 2,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Disabled => "DISABLED",
State::Enabled => "ENABLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"DISABLED" => Some(Self::Disabled),
"ENABLED" => Some(Self::Enabled),
_ => None,
}
}
}
/// Request message for the `EnableService` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnableServiceRequest {
/// Name of the consumer and service to enable the service on.
///
/// The `EnableService` and `DisableService` methods currently only support
/// projects.
///
/// Enabling a service requires that the service is public or is shared with
/// the user enabling the service.
///
/// An example name would be:
/// `projects/123/services/serviceusage.googleapis.com` where `123` is the
/// project number.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Response message for the `EnableService` method.
/// This response message is assigned to the `response` field of the returned
/// Operation when that operation is done.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnableServiceResponse {
/// The new state of the service after enabling.
#[prost(message, optional, tag = "1")]
pub service: ::core::option::Option<Service>,
}
/// Request message for the `DisableService` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DisableServiceRequest {
/// Name of the consumer and service to disable the service on.
///
/// The enable and disable methods currently only support projects.
///
/// An example name would be:
/// `projects/123/services/serviceusage.googleapis.com` where `123` is the
/// project number.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Indicates if services that are enabled and which depend on this service
/// should also be disabled. If not set, an error will be generated if any
/// enabled services depend on the service to be disabled. When set, the
/// service, and any enabled services that depend on it, will be disabled
/// together.
#[prost(bool, tag = "2")]
pub disable_dependent_services: bool,
/// Defines the behavior for checking service usage when disabling a service.
#[prost(enumeration = "disable_service_request::CheckIfServiceHasUsage", tag = "3")]
pub check_if_service_has_usage: i32,
}
/// Nested message and enum types in `DisableServiceRequest`.
pub mod disable_service_request {
/// Enum to determine if service usage should be checked when disabling a
/// service.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum CheckIfServiceHasUsage {
/// When unset, the default behavior is used, which is SKIP.
Unspecified = 0,
/// If set, skip checking service usage when disabling a service.
Skip = 1,
/// If set, service usage is checked when disabling the service. If a
/// service, or its dependents, has usage in the last 30 days, the request
/// returns a FAILED_PRECONDITION error.
Check = 2,
}
impl CheckIfServiceHasUsage {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
CheckIfServiceHasUsage::Unspecified => {
"CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED"
}
CheckIfServiceHasUsage::Skip => "SKIP",
CheckIfServiceHasUsage::Check => "CHECK",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED" => Some(Self::Unspecified),
"SKIP" => Some(Self::Skip),
"CHECK" => Some(Self::Check),
_ => None,
}
}
}
}
/// Response message for the `DisableService` method.
/// This response message is assigned to the `response` field of the returned
/// Operation when that operation is done.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DisableServiceResponse {
/// The new state of the service after disabling.
#[prost(message, optional, tag = "1")]
pub service: ::core::option::Option<Service>,
}
/// Request message for the `GetService` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetServiceRequest {
/// Name of the consumer and service to get the `ConsumerState` for.
///
/// An example name would be:
/// `projects/123/services/serviceusage.googleapis.com` where `123` is the
/// project number.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for the `ListServices` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListServicesRequest {
/// Parent to search for services on.
///
/// An example name would be:
/// `projects/123` where `123` is the project number.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Requested size of the next page of data.
/// Requested page size cannot exceed 200.
/// If not set, the default page size is 50.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Token identifying which result to start with, which is returned by a
/// previous list call.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Only list services that conform to the given filter.
/// The allowed filter strings are `state:ENABLED` and `state:DISABLED`.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
}
/// Response message for the `ListServices` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListServicesResponse {
/// The available services for the requested project.
#[prost(message, repeated, tag = "1")]
pub services: ::prost::alloc::vec::Vec<Service>,
/// Token that can be passed to `ListServices` to resume a paginated
/// query.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for the `BatchEnableServices` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchEnableServicesRequest {
/// Parent to enable services on.
///
/// An example name would be:
/// `projects/123` where `123` is the project number.
///
/// The `BatchEnableServices` method currently only supports projects.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The identifiers of the services to enable on the project.
///
/// A valid identifier would be:
/// serviceusage.googleapis.com
///
/// Enabling services requires that each service is public or is shared with
/// the user enabling the service.
///
/// A single request can enable a maximum of 20 services at a time. If more
/// than 20 services are specified, the request will fail, and no state changes
/// will occur.
#[prost(string, repeated, tag = "2")]
pub service_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for the `BatchEnableServices` method.
/// This response message is assigned to the `response` field of the returned
/// Operation when that operation is done.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchEnableServicesResponse {
/// The new state of the services after enabling.
#[prost(message, repeated, tag = "1")]
pub services: ::prost::alloc::vec::Vec<Service>,
/// If allow_partial_success is true, and one or more services could not be
/// enabled, this field contains the details about each failure.
#[prost(message, repeated, tag = "2")]
pub failures: ::prost::alloc::vec::Vec<
batch_enable_services_response::EnableFailure,
>,
}
/// Nested message and enum types in `BatchEnableServicesResponse`.
pub mod batch_enable_services_response {
/// Provides error messages for the failing services.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnableFailure {
/// The service id of a service that could not be enabled.
#[prost(string, tag = "1")]
pub service_id: ::prost::alloc::string::String,
/// An error message describing why the service could not be enabled.
#[prost(string, tag = "2")]
pub error_message: ::prost::alloc::string::String,
}
}
/// Request message for the `BatchGetServices` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchGetServicesRequest {
/// Parent to retrieve services from.
/// If this is set, the parent of all of the services specified in `names` must
/// match this field. An example name would be: `projects/123` where `123` is
/// the project number. The `BatchGetServices` method currently only supports
/// projects.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Names of the services to retrieve.
///
/// An example name would be:
/// `projects/123/services/serviceusage.googleapis.com` where `123` is the
/// project number.
/// A single request can get a maximum of 30 services at a time.
#[prost(string, repeated, tag = "2")]
pub names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response message for the `BatchGetServices` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchGetServicesResponse {
/// The requested Service states.
#[prost(message, repeated, tag = "1")]
pub services: ::prost::alloc::vec::Vec<Service>,
}
/// Generated client implementations.
pub mod service_usage_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Enables services that service consumers want to use on Google Cloud Platform,
/// lists the available or enabled services, or disables services that service
/// consumers no longer use.
///
/// See [Service Usage API](https://cloud.google.com/service-usage/docs/overview)
#[derive(Debug, Clone)]
pub struct ServiceUsageClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> ServiceUsageClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> ServiceUsageClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
ServiceUsageClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Enable a service so that it can be used with a project.
pub async fn enable_service(
&mut self,
request: impl tonic::IntoRequest<super::EnableServiceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.api.serviceusage.v1.ServiceUsage/EnableService",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.api.serviceusage.v1.ServiceUsage",
"EnableService",
),
);
self.inner.unary(req, path, codec).await
}
/// Disable a service so that it can no longer be used with a project.
/// This prevents unintended usage that may cause unexpected billing
/// charges or security leaks.
///
/// It is not valid to call the disable method on a service that is not
/// currently enabled. Callers will receive a `FAILED_PRECONDITION` status if
/// the target service is not currently enabled.
pub async fn disable_service(
&mut self,
request: impl tonic::IntoRequest<super::DisableServiceRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.api.serviceusage.v1.ServiceUsage/DisableService",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.api.serviceusage.v1.ServiceUsage",
"DisableService",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns the service configuration and enabled state for a given service.
pub async fn get_service(
&mut self,
request: impl tonic::IntoRequest<super::GetServiceRequest>,
) -> std::result::Result<tonic::Response<super::Service>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.api.serviceusage.v1.ServiceUsage/GetService",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.api.serviceusage.v1.ServiceUsage",
"GetService",
),
);
self.inner.unary(req, path, codec).await
}
/// List all services available to the specified project, and the current
/// state of those services with respect to the project. The list includes
/// all public services, all services for which the calling user has the
/// `servicemanagement.services.bind` permission, and all services that have
/// already been enabled on the project. The list can be filtered to
/// only include services in a specific state, for example to only include
/// services enabled on the project.
///
/// WARNING: If you need to query enabled services frequently or across
/// an organization, you should use
/// [Cloud Asset Inventory
/// API](https://cloud.google.com/asset-inventory/docs/apis), which provides
/// higher throughput and richer filtering capability.
pub async fn list_services(
&mut self,
request: impl tonic::IntoRequest<super::ListServicesRequest>,
) -> std::result::Result<
tonic::Response<super::ListServicesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.api.serviceusage.v1.ServiceUsage/ListServices",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.api.serviceusage.v1.ServiceUsage",
"ListServices",
),
);
self.inner.unary(req, path, codec).await
}
/// Enable multiple services on a project. The operation is atomic: if enabling
/// any service fails, then the entire batch fails, and no state changes occur.
/// To enable a single service, use the `EnableService` method instead.
pub async fn batch_enable_services(
&mut self,
request: impl tonic::IntoRequest<super::BatchEnableServicesRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.api.serviceusage.v1.ServiceUsage/BatchEnableServices",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.api.serviceusage.v1.ServiceUsage",
"BatchEnableServices",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns the service configurations and enabled states for a given list of
/// services.
pub async fn batch_get_services(
&mut self,
request: impl tonic::IntoRequest<super::BatchGetServicesRequest>,
) -> std::result::Result<
tonic::Response<super::BatchGetServicesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.api.serviceusage.v1.ServiceUsage/BatchGetServices",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.api.serviceusage.v1.ServiceUsage",
"BatchGetServices",
),
);
self.inner.unary(req, path, codec).await
}
}
}