public final class ApiConfig extends GeneratedMessageV3 implements ApiConfigOrBuilder
An API Configuration is a combination of settings for both the Managed
Service and Gateways serving this API Config.
Protobuf type google.cloud.apigateway.v1.ApiConfig
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
GATEWAY_SERVICE_ACCOUNT_FIELD_NUMBER
public static final int GATEWAY_SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
GRPC_SERVICES_FIELD_NUMBER
public static final int GRPC_SERVICES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MANAGED_SERVICE_CONFIGS_FIELD_NUMBER
public static final int MANAGED_SERVICE_CONFIGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OPENAPI_DOCUMENTS_FIELD_NUMBER
public static final int OPENAPI_DOCUMENTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICE_CONFIG_ID_FIELD_NUMBER
public static final int SERVICE_CONFIG_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ApiConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ApiConfig.Builder newBuilder()
newBuilder(ApiConfig prototype)
public static ApiConfig.Builder newBuilder(ApiConfig prototype)
public static ApiConfig parseDelimitedFrom(InputStream input)
public static ApiConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ApiConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ApiConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ApiConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ApiConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ApiConfig parseFrom(CodedInputStream input)
public static ApiConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ApiConfig parseFrom(InputStream input)
public static ApiConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ApiConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ApiConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ApiConfig> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public ApiConfig getDefaultInstanceForType()
getDisplayName()
public String getDisplayName()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getGatewayServiceAccount()
public 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 |
|---|
| Type | Description |
String | The gatewayServiceAccount.
|
getGatewayServiceAccountBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for gatewayServiceAccount.
|
getGrpcServices(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getGrpcServicesCount()
public 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];
| Returns |
|---|
| Type | Description |
int | |
getGrpcServicesList()
public 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];
getGrpcServicesOrBuilder(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getGrpcServicesOrBuilderList()
public 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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinitionOrBuilder> | |
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
| Parameter |
|---|
| Name | Description |
key | String
|
getManagedServiceConfigs(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getManagedServiceConfigsCount()
public 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];
| Returns |
|---|
| Type | Description |
int | |
getManagedServiceConfigsList()
public 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];
getManagedServiceConfigsOrBuilder(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getManagedServiceConfigsOrBuilderList()
public 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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.apigateway.v1.ApiConfig.FileOrBuilder> | |
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 |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getOpenapiDocuments(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getOpenapiDocumentsCount()
public 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];
| Returns |
|---|
| Type | Description |
int | |
getOpenapiDocumentsList()
public 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];
getOpenapiDocumentsOrBuilder(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getOpenapiDocumentsOrBuilderList()
public 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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.apigateway.v1.ApiConfig.OpenApiDocumentOrBuilder> | |
getParserForType()
public Parser<ApiConfig> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getServiceConfigId()
public String getServiceConfigId()
| Returns |
|---|
| Type | Description |
String | The serviceConfigId.
|
getServiceConfigIdBytes()
public ByteString getServiceConfigIdBytes()
| Returns |
|---|
| Type | Description |
ByteString | The bytes for serviceConfigId.
|
getState()
public ApiConfig.State getState()
Output only. State of the API Config.
.google.cloud.apigateway.v1.ApiConfig.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. State of the API Config.
.google.cloud.apigateway.v1.ApiConfig.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ApiConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ApiConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ApiConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
