apigee.v1 library Null safety

Apigee API - v1

Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.

For more information, see cloud.google.com/apigee-api-management/

Create an instance of ApigeeApi to access these resources:

Classes

ApigeeApi
Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. [...]
EdgeConfigstoreBundleBadBundle
Describes why a bundle is invalid. [...]
EdgeConfigstoreBundleBadBundleViolation
A message type used to describe a single bundle validation error.
GoogleCloudApigeeV1Access
GoogleCloudApigeeV1AccessGet
Get action. [...]
GoogleCloudApigeeV1AccessRemove
Remove action. [...]
GoogleCloudApigeeV1AccessSet
Set action. [...]
GoogleCloudApigeeV1AddonsConfig
Add-on configurations for the Apigee organization.
GoogleCloudApigeeV1AdvancedApiOpsConfig
Configuration for the Advanced API Ops add-on.
GoogleCloudApigeeV1Alias
Reference to a certificate or key/certificate pair.
GoogleCloudApigeeV1AliasRevisionConfig
GoogleCloudApigeeV1ApiCategory
the Api category resource wrapped with response status, error_code etc.
GoogleCloudApigeeV1ApiCategoryData
the Api category resource.
GoogleCloudApigeeV1ApiProduct
GoogleCloudApigeeV1ApiProductRef
GoogleCloudApigeeV1ApiProxy
Metadata describing the API proxy
GoogleCloudApigeeV1ApiProxyRevision
API proxy revision.
GoogleCloudApigeeV1ApiResponseWrapper
GoogleCloudApigeeV1App
GoogleCloudApigeeV1ArchiveDeployment
Archive Deployment information.
GoogleCloudApigeeV1AsyncQuery
GoogleCloudApigeeV1AsyncQueryResult
GoogleCloudApigeeV1AsyncQueryResultView
GoogleCloudApigeeV1Attribute
Key-value pair to store extra metadata.
GoogleCloudApigeeV1Attributes
GoogleCloudApigeeV1CanaryEvaluation
CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests.
GoogleCloudApigeeV1CanaryEvaluationMetricLabels
Labels that can be used to filter Apigee metrics.
GoogleCloudApigeeV1Certificate
GoogleCloudApigeeV1CertInfo
X.509 certificate as defined in RFC 5280.
GoogleCloudApigeeV1CommonNameConfig
GoogleCloudApigeeV1ConfigVersion
Version of the API proxy configuration schema. [...]
GoogleCloudApigeeV1ConnectorsPlatformConfig
Configuration for the Connectors Platform add-on.
GoogleCloudApigeeV1Credential
GoogleCloudApigeeV1CreditDeveloperBalanceRequest
Request for CreditDeveloperBalance.
GoogleCloudApigeeV1CustomReport
GoogleCloudApigeeV1CustomReportMetric
This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum
GoogleCloudApigeeV1DataCollector
Data collector configuration.
GoogleCloudApigeeV1DataCollectorConfig
Data collector and its configuration.
GoogleCloudApigeeV1Datastore
The data store defines the connection to export data repository (Cloud Storage, BigQuery), including the credentials used to access the data repository.
GoogleCloudApigeeV1DatastoreConfig
Configuration detail for datastore
GoogleCloudApigeeV1DateRange
Date range of the data to export.
GoogleCloudApigeeV1DebugMask
GoogleCloudApigeeV1DebugSession
GoogleCloudApigeeV1DebugSessionTransaction
A transaction contains all of the debug information of the entire message flow of an API call processed by the runtime plane. [...]
GoogleCloudApigeeV1DeleteCustomReportResponse
GoogleCloudApigeeV1Deployment
GoogleCloudApigeeV1DeploymentChangeReport
Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. [...]
GoogleCloudApigeeV1DeploymentChangeReportRoutingChange
Describes a potential routing change that may occur as a result of some deployment operation.
GoogleCloudApigeeV1DeploymentChangeReportRoutingConflict
Describes a routing conflict that may cause a deployment not to receive traffic at some base path.
GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment
Tuple representing a base path and the deployment containing it.
GoogleCloudApigeeV1DeploymentConfig
NEXT ID: 9
GoogleCloudApigeeV1Developer
GoogleCloudApigeeV1DeveloperApp
GoogleCloudApigeeV1DeveloperAppKey
GoogleCloudApigeeV1DeveloperBalance
Account balance for the developer.
GoogleCloudApigeeV1DeveloperBalanceWallet
Wallet used to manage an account balance for a particular currency.
GoogleCloudApigeeV1DeveloperMonetizationConfig
Monetization configuration for the developer.
GoogleCloudApigeeV1DeveloperSubscription
Structure of a DeveloperSubscription.
GoogleCloudApigeeV1DimensionMetric
This message type encapsulates a metric grouped by dimension.
GoogleCloudApigeeV1EntityMetadata
Metadata common to many entities in this API.
GoogleCloudApigeeV1Environment
GoogleCloudApigeeV1EnvironmentConfig
GoogleCloudApigeeV1EnvironmentGroup
EnvironmentGroup configuration. [...]
GoogleCloudApigeeV1EnvironmentGroupAttachment
EnvironmentGroupAttachment is a resource which defines an attachment of an environment to an environment group.
GoogleCloudApigeeV1EnvironmentGroupConfig
EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.
GoogleCloudApigeeV1Export
Details of an export job.
GoogleCloudApigeeV1ExportRequest
Request body for [CreateExportRequest]
GoogleCloudApigeeV1FlowHook
GoogleCloudApigeeV1FlowHookConfig
GoogleCloudApigeeV1GenerateDownloadUrlResponse
Response for GenerateDownloadUrl method.
GoogleCloudApigeeV1GenerateUploadUrlResponse
Response for GenerateUploadUrl method.
GoogleCloudApigeeV1GraphQLOperation
Represents the pairing of GraphQL operation types and the GraphQL operation name.
GoogleCloudApigeeV1GraphQLOperationConfig
Binds the resources in a proxy or remote service with the GraphQL operation and its associated quota enforcement.
GoogleCloudApigeeV1GraphQLOperationGroup
List of graphQL operation configuration details associated with Apigee API proxies or remote services. [...]
GoogleCloudApigeeV1IngressConfig
GoogleCloudApigeeV1Instance
Apigee runtime instance.
GoogleCloudApigeeV1InstanceAttachment
InstanceAttachment represents the installation of an environment onto an instance.
GoogleCloudApigeeV1InstanceDeploymentStatus
The status of a deployment as reported by a single instance.
GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRevision
Revisions deployed in the MPs.
GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute
Route deployed in the ingress routing table.
GoogleCloudApigeeV1IntegrationConfig
Configuration for the Integration add-on.
GoogleCloudApigeeV1KeyAliasReference
GoogleCloudApigeeV1Keystore
Datastore for Certificates and Aliases.
GoogleCloudApigeeV1KeystoreConfig
GoogleCloudApigeeV1KeyValueMap
A collection of key, value string pairs
GoogleCloudApigeeV1ListApiCategoriesResponse
the response for ListApiCategoriesRequest.
GoogleCloudApigeeV1ListApiProductsResponse
GoogleCloudApigeeV1ListApiProxiesResponse
GoogleCloudApigeeV1ListAppsResponse
GoogleCloudApigeeV1ListArchiveDeploymentsResponse
Response for ListArchiveDeployments method.
GoogleCloudApigeeV1ListAsyncQueriesResponse
The response for ListAsyncQueries.
GoogleCloudApigeeV1ListCustomReportsResponse
This message encapsulates a list of custom report definitions
GoogleCloudApigeeV1ListDataCollectorsResponse
Response for ListDataCollectors.
GoogleCloudApigeeV1ListDatastoresResponse
The response for ListDatastores
GoogleCloudApigeeV1ListDebugSessionsResponse
GoogleCloudApigeeV1ListDeploymentsResponse
GoogleCloudApigeeV1ListDeveloperAppsResponse
GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse
Response for ListDeveloperSubscriptions.
GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse
Response for ListEnvironmentGroupAttachments.
GoogleCloudApigeeV1ListEnvironmentGroupsResponse
Response for ListEnvironmentGroups.
GoogleCloudApigeeV1ListEnvironmentResourcesResponse
Response for ListEnvironmentResources
GoogleCloudApigeeV1ListExportsResponse
The response for ListExports
GoogleCloudApigeeV1ListHybridIssuersResponse
GoogleCloudApigeeV1ListInstanceAttachmentsResponse
Response for ListInstanceAttachments.
GoogleCloudApigeeV1ListInstancesResponse
Response for ListInstances.
GoogleCloudApigeeV1ListNatAddressesResponse
Response for ListNatAddresses.
GoogleCloudApigeeV1ListOfDevelopersResponse
GoogleCloudApigeeV1ListOrganizationsResponse
GoogleCloudApigeeV1ListRatePlansResponse
Response for ListRatePlans.
GoogleCloudApigeeV1ListSharedFlowsResponse
GoogleCloudApigeeV1ListTraceConfigOverridesResponse
Response for ListTraceConfigOverrides.
GoogleCloudApigeeV1Metadata
This message type encapsulates additional information about query execution.
GoogleCloudApigeeV1Metric
This message type encapsulates the metric data point. [...]
GoogleCloudApigeeV1MonetizationConfig
Configuration for the Monetization add-on.
GoogleCloudApigeeV1NatAddress
Apigee NAT(network address translation) address. [...]
GoogleCloudApigeeV1Operation
Represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.
GoogleCloudApigeeV1OperationConfig
Binds the resources in an API proxy or remote service with the allowed REST methods and associated quota enforcement.
GoogleCloudApigeeV1OperationGroup
List of operation configuration details associated with Apigee API proxies or remote services. [...]
GoogleCloudApigeeV1OperationMetadata
Metadata describing an Operation.
GoogleCloudApigeeV1OperationMetadataProgress
Information about operation progress.
GoogleCloudApigeeV1OptimizedStats
GoogleCloudApigeeV1OptimizedStatsNode
This message type encapsulates a data node as represented below: { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] } OR { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics.
GoogleCloudApigeeV1OptimizedStatsResponse
This message type encapsulates a response format for Js Optimized Scenario.
GoogleCloudApigeeV1Organization
GoogleCloudApigeeV1OrganizationProjectMapping
GoogleCloudApigeeV1PodStatus
GoogleCloudApigeeV1Point
Point is a group of information collected by runtime plane at critical points of the message flow of the processed API request. [...]
GoogleCloudApigeeV1Properties
Message for compatibility with legacy Edge specification for Java Properties object in JSON.
GoogleCloudApigeeV1Property
A single property entry in the Properties message.
GoogleCloudApigeeV1ProvisionOrganizationRequest
Request for ProvisionOrganization.
GoogleCloudApigeeV1Query
GoogleCloudApigeeV1QueryMetadata
GoogleCloudApigeeV1QueryMetric
More info about Metric: https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics
GoogleCloudApigeeV1Quota
Quota contains the essential parameters needed that can be applied on the resources, methods, API source combination associated with this API product. [...]
GoogleCloudApigeeV1RatePlan
Rate plan details.
GoogleCloudApigeeV1RateRange
API call volume range and the fees charged when the total number of API calls is within the range.
GoogleCloudApigeeV1Reference
A Reference configuration. [...]
GoogleCloudApigeeV1ReferenceConfig
GoogleCloudApigeeV1ReportInstanceStatusRequest
Request for ReportInstanceStatus.
GoogleCloudApigeeV1ReportProperty
GoogleCloudApigeeV1ResourceConfig
GoogleCloudApigeeV1ResourceFile
Metadata about a resource file.
GoogleCloudApigeeV1ResourceFiles
List of resource files.
GoogleCloudApigeeV1ResourceStatus
The status of a resource loaded in the runtime.
GoogleCloudApigeeV1Result
Result is short for "action result", could be different types identified by "action_result" field. [...]
GoogleCloudApigeeV1RevenueShareRange
API call volume range and the percentage of revenue to share with the developer when the total number of API calls is within the range.
GoogleCloudApigeeV1RevisionStatus
The status of a specific resource revision.
GoogleCloudApigeeV1RoutingRule
GoogleCloudApigeeV1RuntimeConfig
Runtime configuration for the organization. [...]
GoogleCloudApigeeV1RuntimeTraceConfig
NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment.
GoogleCloudApigeeV1RuntimeTraceConfigOverride
NEXT ID: 7 Trace configuration override for a specific API proxy in an environment.
GoogleCloudApigeeV1Schema
Response for Schema call
GoogleCloudApigeeV1SchemaSchemaElement
Message type for the schema element
GoogleCloudApigeeV1SchemaSchemaProperty
Properties for the schema field.
GoogleCloudApigeeV1ServiceIssuersMapping
GoogleCloudApigeeV1Session
Session carries the debug session id and its creation time.
GoogleCloudApigeeV1SetAddonsRequest
Request for SetAddons.
GoogleCloudApigeeV1SharedFlow
The metadata describing a shared flow
GoogleCloudApigeeV1SharedFlowRevision
The metadata describing a shared flow revision.
GoogleCloudApigeeV1Stats
This message type encapsulates a stats response.
GoogleCloudApigeeV1StatsEnvironmentStats
This message type encapsulates the environment wrapper: "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "prod" } ]
GoogleCloudApigeeV1StatsHostStats
This message type encapsulates the hostname wrapper: "hosts": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "2.52056245E8" ] } ], "name": "example.com" } ]
GoogleCloudApigeeV1Subscription
Pub/Sub subscription of an environment.
GoogleCloudApigeeV1SyncAuthorization
GoogleCloudApigeeV1TargetServer
TargetServer configuration. [...]
GoogleCloudApigeeV1TargetServerConfig
GoogleCloudApigeeV1TestDatastoreResponse
The response for TestDatastore
GoogleCloudApigeeV1TlsInfo
TLS configuration information for VirtualHosts and TargetServers.
GoogleCloudApigeeV1TlsInfoCommonName
GoogleCloudApigeeV1TlsInfoConfig
GoogleCloudApigeeV1TraceConfig
TraceConfig defines the configurations in an environment of distributed trace.
GoogleCloudApigeeV1TraceConfigOverride
A representation of a configuration override.
GoogleCloudApigeeV1UpdateError
Details on why a resource update failed in the runtime.
GoogleIamV1AuditConfig
Specifies the audit configuration for a service. [...]
GoogleIamV1Binding
Associates members with a role.
GoogleIamV1Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. [...]
GoogleIamV1SetIamPolicyRequest
Request message for SetIamPolicy method.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
GoogleRpcPreconditionFailure
Describes what preconditions have failed. [...]
GoogleRpcPreconditionFailureViolation
A message type used to describe a single precondition failure.
HybridIssuersResource
HybridResource
OrganizationsAnalyticsDatastoresResource
OrganizationsAnalyticsResource
OrganizationsApiproductsAttributesResource
OrganizationsApiproductsRateplansResource
OrganizationsApiproductsResource
OrganizationsApisDeploymentsResource
OrganizationsApisKeyvaluemapsResource
OrganizationsApisResource
OrganizationsApisRevisionsDeploymentsResource
OrganizationsApisRevisionsResource
OrganizationsAppsResource
OrganizationsDatacollectorsResource
OrganizationsDeploymentsResource
OrganizationsDevelopersAppsAttributesResource
OrganizationsDevelopersAppsKeysApiproductsResource
OrganizationsDevelopersAppsKeysCreateResource
OrganizationsDevelopersAppsKeysResource
OrganizationsDevelopersAppsResource
OrganizationsDevelopersAttributesResource
OrganizationsDevelopersBalanceResource
OrganizationsDevelopersResource
OrganizationsDevelopersSubscriptionsResource
OrganizationsEnvgroupsAttachmentsResource
OrganizationsEnvgroupsResource
OrganizationsEnvironmentsAnalyticsAdminResource
OrganizationsEnvironmentsAnalyticsExportsResource
OrganizationsEnvironmentsAnalyticsResource
OrganizationsEnvironmentsApisDeploymentsResource
OrganizationsEnvironmentsApisResource
OrganizationsEnvironmentsApisRevisionsDebugsessionsDataResource
OrganizationsEnvironmentsApisRevisionsDebugsessionsResource
OrganizationsEnvironmentsApisRevisionsDeploymentsResource
OrganizationsEnvironmentsApisRevisionsResource
OrganizationsEnvironmentsArchiveDeploymentsResource
OrganizationsEnvironmentsCachesResource
OrganizationsEnvironmentsDeploymentsResource
OrganizationsEnvironmentsFlowhooksResource
OrganizationsEnvironmentsKeystoresAliasesResource
OrganizationsEnvironmentsKeystoresResource
OrganizationsEnvironmentsKeyvaluemapsResource
OrganizationsEnvironmentsOptimizedStatsResource
OrganizationsEnvironmentsQueriesResource
OrganizationsEnvironmentsReferencesResource
OrganizationsEnvironmentsResource
OrganizationsEnvironmentsResourcefilesResource
OrganizationsEnvironmentsSharedflowsDeploymentsResource
OrganizationsEnvironmentsSharedflowsResource
OrganizationsEnvironmentsSharedflowsRevisionsResource
OrganizationsEnvironmentsStatsResource
OrganizationsEnvironmentsTargetserversResource
OrganizationsEnvironmentsTraceConfigOverridesResource
OrganizationsEnvironmentsTraceConfigResource
OrganizationsHostQueriesResource
OrganizationsHostStatsResource
OrganizationsInstancesAttachmentsResource
OrganizationsInstancesCanaryevaluationsResource
OrganizationsInstancesNatAddressesResource
OrganizationsInstancesResource
OrganizationsKeyvaluemapsResource
OrganizationsOperationsResource
OrganizationsOptimizedHostStatsResource
OrganizationsReportsResource
OrganizationsResource
OrganizationsSharedflowsDeploymentsResource
OrganizationsSharedflowsResource
OrganizationsSharedflowsRevisionsDeploymentsResource
OrganizationsSharedflowsRevisionsResource
OrganizationsSitesApicategoriesResource
OrganizationsSitesResource
ProjectsResource

Typedefs

GoogleApiHttpBody = $HttpBody
Message that represents an arbitrary HTTP body. [...]
GoogleCloudApigeeV1ActivateNatAddressRequest = $Empty
Request for ActivateNatAddressRequest. [...]
GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest = $Empty
Request for ExpireDeveloperSubscription.
GoogleCloudApigeeV1GenerateDownloadUrlRequest = $Empty
Request for GenerateDownloadUrl method.
GoogleCloudApigeeV1GenerateUploadUrlRequest = $Empty
Request for GenerateUploadUrl method.
GoogleCloudApigeeV1GetSyncAuthorizationRequest = $Empty
Request for GetSyncAuthorization.
GoogleCloudApigeeV1ReportInstanceStatusResponse = $Empty
Placeholder for future enhancements to status reporting protocol
GoogleCloudApigeeV1RuntimeTraceSamplingConfig = $TraceSamplingConfig
NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. [...]
GoogleCloudApigeeV1TraceSamplingConfig = $TraceSamplingConfig
TraceSamplingConfig represents the detail settings of distributed tracing. [...]
GoogleIamV1AuditLogConfig = $AuditLogConfig
Provides the configuration for logging a type of permissions. [...]
GoogleIamV1TestIamPermissionsRequest = $TestIamPermissionsRequest
Request message for TestIamPermissions method.
GoogleIamV1TestIamPermissionsResponse = $PermissionsResponse
Response message for TestIamPermissions method.
GoogleProtobufEmpty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
GoogleRpcStatus = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
GoogleTypeExpr = $Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. [...]
GoogleTypeMoney = $Money
Represents an amount of money with its currency type.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.