workloadmanager/v1 library

Workload Manager API - v1

Workload Manager is a service that provides tooling for enterprise workloads to automate the deployment and validation of your workloads against best practices and recommendations.

For more information, see cloud.google.com/workload-manager/docs

Create an instance of WorkloadManagerApi to access these resources:

Classes

AgentCommand
  • An AgentCommand specifies a one-time executable program for the agent to run.
    • APILayerServer
    The API layer server
    AvailabilityGroup
    The availability groups for sqlserver
    BackendServer
    The backend server
    BackupProperties
    Backup properties.
    BigQueryDestination
    Message describing big query destination
    CloudResource
    The resource on GCP
    Cluster
    The cluster for sqlserver
    Command
  • Command specifies the type of command to execute.
    • ComponentHealth
    HealthCondition contains the detailed health check of each component.
    Database
    The database for sqlserver
    DatabaseProperties
    Database Properties.
    Evaluation
    LINT.IfChange Message describing Evaluation object
    Execution
    Message describing Execution object
    ExecutionResult
    Message describing the result of an execution
    ExternalDataSources
    Message for external data sources
    FrontEndServer
    The front end server
    GceInstanceFilter
    Message describing compute engine instance filter
    HealthCheck
    HealthCheck contains the detailed health check of a component based on asource.
    Insight
    A presentation of host resource usage where the workload runs.
    Instance
    a vm instance
    InstanceProperties
    Instance Properties.
    Layer
    The database layer
    ListDiscoveredProfilesResponse
    List discovered profile Response returns discovered profiles from agents
    ListEvaluationsResponse
    Message for response to listing Evaluations
    ListExecutionResultsResponse
    Message for response of list execution results
    ListExecutionsResponse
    Message for response to listing Executions
    ListLocationsResponse
    The response message for Locations.ListLocations.
    ListOperationsResponse
    The response message for Operations.ListOperations.
    ListRulesResponse
    Mesesage of response of list rules
    ListScannedResourcesResponse
    Message for response to list scanned resources
    LoadBalancerServer
    The load balancer for sqlserver
    Notice
    Message for additional information generated by the execution
    Operation
    This resource represents a long-running operation that is the result of a network API call.
    ProjectsLocationsDiscoveredprofilesHealthesResource
    ProjectsLocationsDiscoveredprofilesResource
    ProjectsLocationsEvaluationsExecutionsResource
    ProjectsLocationsEvaluationsExecutionsResultsResource
    ProjectsLocationsEvaluationsExecutionsScannedResourcesResource
    ProjectsLocationsEvaluationsResource
    ProjectsLocationsInsightsResource
    ProjectsLocationsOperationsResource
    ProjectsLocationsResource
    ProjectsLocationsRulesResource
    ProjectsResource
    Resource
    Message represent resource in execution result
    ResourceFilter
    Message describing resource filters
    ResourceStatus
    Message describing resource status
    Rule
    Message represent a rule
    RuleExecutionResult
    Message for execution result summary per rule
    RunEvaluationRequest
    Message for creating a Execution
    SapComponent
    The component of sap workload
    SapDiscovery
    The schema of SAP system discovery data.
    SapDiscoveryComponent
    Message describing the system component.
    SapDiscoveryComponentApplicationProperties
    A set of properties describing an SAP Application layer.
    SapDiscoveryComponentDatabaseProperties
    A set of properties describing an SAP Database layer.
    SapDiscoveryComponentReplicationSite
    A replication site used in Disaster Recovery (DR) configurations.
    SapDiscoveryMetadata
    Message describing SAP discovery system metadata
    SapDiscoveryResource
    Message describing a resource.
    SapDiscoveryResourceInstanceProperties
    A set of properties only present for an instance type resource
    SapDiscoveryResourceInstancePropertiesAppInstance
    Fields to describe an SAP application server instance.
    SapDiscoveryResourceInstancePropertiesDiskMount
    Disk mount on the instance.
    SapDiscoveryWorkloadProperties
    A set of properties describing an SAP workload.
    SapDiscoveryWorkloadPropertiesSoftwareComponentProperties
    A SAP software component name, version, and type.
    SapInstanceProperties
    SAP instance properties.
    SapValidation
    A presentation of SAP workload insight.
    SapValidationValidationDetail
    Message describing the SAP validation metrics.
    SapWorkload
    The body of sap workload
    ScannedResource
    Message of scanned resource
    ShellCommand
  • A ShellCommand is invoked via the agent's command line executor
    • SqlserverValidation
    A presentation of SQLServer workload insight.
    SqlserverValidationDetails
    Message containing collected data names and values.
    SqlserverValidationValidationDetail
    Message describing the Sqlserver validation metrics.
    SqlserverWorkload
    The body of sqlserver workload
    Summary
    Message for execution summary
    ThreeTierWorkload
    The body of three tier workload
    TorsoValidation
    The schema of torso workload validation data.
    UpcomingMaintenanceEvent
    Maintenance Event
    ViolationDetails
    Message describing the violation in an evaluation result.
    WorkloadManagerApi
    Workload Manager is a service that provides tooling for enterprise workloads to automate the deployment and validation of your workloads against best practices and recommendations.
    WorkloadProfile
    workload resource
    WorkloadProfileHealth
    WorkloadProfileHealth contains the detailed health check of workload.
    WriteInsightRequest
    Request for sending the data insights.

    Typedefs

    CancelOperationRequest = $Empty
    The request message for Operations.CancelOperation.
    Empty = $Empty
    A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
    Location = $Location00
    A resource that represents a Google Cloud location.
    Product = $Shared16
    Product contains the details of a product.
    SapDiscoveryWorkloadPropertiesProductVersion = $Shared16
    A product name and version.
    Status = $Status00
    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
    WriteInsightResponse = $Empty
    The response for write insights request.

    Exceptions / Errors

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