Struct ApiConfig 

#[non_exhaustive]
pub struct ApiConfig {
    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub display_name: String,
    pub gateway_service_account: String,
    pub service_config_id: String,
    pub state: State,
    pub openapi_documents: Vec<OpenApiDocument>,
    pub grpc_services: Vec<GrpcServiceDefinition>,
    pub managed_service_configs: Vec<File>,
    /* private fields */
}

An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

create_time: Option<Timestamp>

Output only. Created time.

update_time: Option<Timestamp>

Output only. Updated time.

labels: HashMap<String, String>

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

display_name: String

Optional. Display name.

gateway_service_account: String

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account’s email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

service_config_id: String

Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

state: State

Output only. State of the API Config.

openapi_documents: Vec<OpenApiDocument>

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

grpc_services: Vec<GrpcServiceDefinition>

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

managed_service_configs: Vec<File>

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents.

If multiple files are specified, the files are merged with the following rules:

• All singular scalar fields are merged using “last one wins” semantics in the order of the files uploaded.
• Repeated fields are concatenated.
• Singular embedded messages are merged using these rules for nested fields.

Implementations

impl ApiConfig

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = ApiConfig::new().set_name("example");

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = ApiConfig::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = ApiConfig::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = ApiConfig::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = ApiConfig::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = ApiConfig::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = ApiConfig::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = ApiConfig::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = ApiConfig::new().set_display_name("example");

pub fn set_gateway_service_account<T: Into<String>>(self, v: T) -> Self

Sets the value of gateway_service_account.

Example

let x = ApiConfig::new().set_gateway_service_account("example");

pub fn set_service_config_id<T: Into<String>>(self, v: T) -> Self

Sets the value of service_config_id.

Example

let x = ApiConfig::new().set_service_config_id("example");

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_apigateway_v1::model::api_config::State;
let x0 = ApiConfig::new().set_state(State::Creating);
let x1 = ApiConfig::new().set_state(State::Active);
let x2 = ApiConfig::new().set_state(State::Failed);

pub fn set_openapi_documents<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<OpenApiDocument>,

Sets the value of openapi_documents.

Example

use google_cloud_apigateway_v1::model::api_config::OpenApiDocument;
let x = ApiConfig::new()
    .set_openapi_documents([
        OpenApiDocument::default()/* use setters */,
        OpenApiDocument::default()/* use (different) setters */,
    ]);

pub fn set_grpc_services<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<GrpcServiceDefinition>,

Sets the value of grpc_services.

Example

use google_cloud_apigateway_v1::model::api_config::GrpcServiceDefinition;
let x = ApiConfig::new()
    .set_grpc_services([
        GrpcServiceDefinition::default()/* use setters */,
        GrpcServiceDefinition::default()/* use (different) setters */,
    ]);

pub fn set_managed_service_configs<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<File>,

Sets the value of managed_service_configs.

Example

use google_cloud_apigateway_v1::model::api_config::File;
let x = ApiConfig::new()
    .set_managed_service_configs([
        File::default()/* use setters */,
        File::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for ApiConfig

fn clone(&self) -> ApiConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApiConfig

fn default() -> ApiConfig

Returns the “default value” for a type.

impl Message for ApiConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ApiConfig

fn eq(&self, other: &ApiConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ApiConfig