NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

DeploymentChangeReport

Response for deployments.generateDeployChangeReport and deployments.generateUndeployChangeReport.

This report contains any validation failures that would cause the deployment to be rejected, as well changes and conflicts in routing that may occur due to the new deployment.

The existence of a routing warning does not necessarily imply that the deployment request is bad, if the desired state of the deployment request is to effect a routing change. The primary purposes of the routing messages are:

1) To inform users of routing changes that may have an effect on traffic currently being routed to other existing deployments.

2) To warn users if some basepath in the proxy will not receive traffic due to an existing deployment having already claimed that basepath.

The presence of routing conflicts/changes will not cause non-dry-run revisions.deploy/revisions.undeploy requests to be rejected.

JSON representation
{
  "validationErrors": {
    object (PreconditionFailure)
  },
  "routingChanges": [
    {
      object (RoutingChange)
    }
  ],
  "routingConflicts": [
    {
      object (RoutingConflict)
    }
  ]
}
Fields
validationErrors

object (PreconditionFailure)

Validation errors that would cause the deployment change request to be rejected.

routingChanges[]

object (RoutingChange)

All routing changes that may result from a deployment request.

routingConflicts[]

object (RoutingConflict)

All basepath conflicts detected for a deployment request.

PreconditionFailure

Describes what preconditions have failed.

For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.

JSON representation
{
  "violations": [
    {
      object (Violation)
    }
  ]
}
Fields
violations[]

object (Violation)

Describes all precondition violations.

Violation

A message type used to describe a single precondition failure.

JSON representation
{
  "type": string,
  "subject": string,
  "description": string
}
Fields
type

string

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

subject

string

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

description

string

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

RoutingChange

Describes a potential routing change that may occur as a result of some deployment operation.

JSON representation
{
  "environmentGroup": string,
  "fromDeployment": {
    object (RoutingDeployment)
  },
  "toDeployment": {
    object (RoutingDeployment)
  },
  "shouldSequenceRollout": boolean,
  "description": string
}
Fields
environmentGroup

string

The name of the environment group affected by this routing change.

fromDeployment

object (RoutingDeployment)

The basepath/deployment that may stop receiving some traffic.

toDeployment

object (RoutingDeployment)

The basepath/deployment that may start receiving that traffic. May be null if no deployment is able to receive the traffic.

shouldSequenceRollout

boolean

True if using sequenced rollout would make this routing change safer. Note: this does not necessarily imply that automated sequenced rollout mode is supported for the operation.

description

string

A human-readable description of this routing change.