Package com.google.cloud.apigateway.v1

Interface ApiConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ApiConfig, ApiConfig.Builder
    public interface ApiConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. Resource name of the API Config.
 Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. Resource name of the API Config.
 Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Created time.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Created time.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Created time.
        .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. Updated time.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. Updated time.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Updated time.
        .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

        int getLabelsCount()
         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
        map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

      • containsLabels

        boolean containsLabels​(String key)
         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
        map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         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
        map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         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
        map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         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
        map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

      • getDisplayName

        String getDisplayName()
         Optional. Display name.
        string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. Display name.
        string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for displayName.

      • getGatewayServiceAccount

        String getGatewayServiceAccount()
         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.
        string gateway_service_account = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        The gatewayServiceAccount.

      • getGatewayServiceAccountBytes

        com.google.protobuf.ByteString getGatewayServiceAccountBytes()
         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.
        string gateway_service_account = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for gatewayServiceAccount.

      • getServiceConfigId

        String getServiceConfigId()
         Output only. The ID of the associated Service Config (
 https://cloud.google.com/service-infrastructure/docs/glossary#config).
        string service_config_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The serviceConfigId.

      • getServiceConfigIdBytes

        com.google.protobuf.ByteString getServiceConfigIdBytes()
         Output only. The ID of the associated Service Config (
 https://cloud.google.com/service-infrastructure/docs/glossary#config).
        string service_config_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for serviceConfigId.

      • getStateValue

        int getStateValue()
         Output only. State of the API Config.
        .google.cloud.apigateway.v1.ApiConfig.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        ApiConfig.State getState()
         Output only. State of the API Config.
        .google.cloud.apigateway.v1.ApiConfig.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • getOpenapiDocumentsList

        List<ApiConfig.OpenApiDocument> getOpenapiDocumentsList()
         Optional. OpenAPI specification documents. If specified, grpc_services and
 managed_service_configs must not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getOpenapiDocuments

        ApiConfig.OpenApiDocument getOpenapiDocuments​(int index)
         Optional. OpenAPI specification documents. If specified, grpc_services and
 managed_service_configs must not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getOpenapiDocumentsCount

        int getOpenapiDocumentsCount()
         Optional. OpenAPI specification documents. If specified, grpc_services and
 managed_service_configs must not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getOpenapiDocumentsOrBuilderList

        List<? extends ApiConfig.OpenApiDocumentOrBuilder> getOpenapiDocumentsOrBuilderList()
         Optional. OpenAPI specification documents. If specified, grpc_services and
 managed_service_configs must not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getOpenapiDocumentsOrBuilder

        ApiConfig.OpenApiDocumentOrBuilder getOpenapiDocumentsOrBuilder​(int index)
         Optional. OpenAPI specification documents. If specified, grpc_services and
 managed_service_configs must not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getGrpcServicesList

        List<ApiConfig.GrpcServiceDefinition> getGrpcServicesList()
         Optional. gRPC service definition files. If specified, openapi_documents must
 not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getGrpcServices

        ApiConfig.GrpcServiceDefinition getGrpcServices​(int index)
         Optional. gRPC service definition files. If specified, openapi_documents must
 not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getGrpcServicesCount

        int getGrpcServicesCount()
         Optional. gRPC service definition files. If specified, openapi_documents must
 not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getGrpcServicesOrBuilderList

        List<? extends ApiConfig.GrpcServiceDefinitionOrBuilder> getGrpcServicesOrBuilderList()
         Optional. gRPC service definition files. If specified, openapi_documents must
 not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getGrpcServicesOrBuilder

        ApiConfig.GrpcServiceDefinitionOrBuilder getGrpcServicesOrBuilder​(int index)
         Optional. gRPC service definition files. If specified, openapi_documents must
 not be included.
        repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getManagedServiceConfigsList

        List<ApiConfig.File> getManagedServiceConfigsList()
         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.
        repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getManagedServiceConfigs

        ApiConfig.File getManagedServiceConfigs​(int index)
         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.
        repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getManagedServiceConfigsCount

        int getManagedServiceConfigsCount()
         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.
        repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getManagedServiceConfigsOrBuilderList

        List<? extends ApiConfig.FileOrBuilder> getManagedServiceConfigsOrBuilderList()
         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.
        repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getManagedServiceConfigsOrBuilder

        ApiConfig.FileOrBuilder getManagedServiceConfigsOrBuilder​(int index)
         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.
        repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL];