Workload Manager API . projects . locations . workloadProfiles

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets details of a single workload.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

List workloads

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets details of a single workload.

Args:
  name: string, Required. Name of the resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # workload resource
  "application": { # The database layer # Optional. The application layer
    "applicationType": "A String", # the application layer
    "databaseType": "A String", # Optional. the database layer
    "instances": [ # Optional. instances in a layer
      { # a vm instance
        "name": "A String", # Output only. name of the VM
        "region": "A String", # Output only. The location of the VM
        "status": "A String", # Output only. The state of the VM
      },
    ],
    "sid": "A String", # Output only. system identification of a layer
  },
  "ascs": { # The database layer # Optional. The ascs layer
    "applicationType": "A String", # the application layer
    "databaseType": "A String", # Optional. the database layer
    "instances": [ # Optional. instances in a layer
      { # a vm instance
        "name": "A String", # Output only. name of the VM
        "region": "A String", # Output only. The location of the VM
        "status": "A String", # Output only. The state of the VM
      },
    ],
    "sid": "A String", # Output only. system identification of a layer
  },
  "database": { # The database layer # Optional. The database layer
    "applicationType": "A String", # the application layer
    "databaseType": "A String", # Optional. the database layer
    "instances": [ # Optional. instances in a layer
      { # a vm instance
        "name": "A String", # Output only. name of the VM
        "region": "A String", # Output only. The location of the VM
        "status": "A String", # Output only. The state of the VM
      },
    ],
    "sid": "A String", # Output only. system identification of a layer
  },
  "labels": { # Optional. such as name, description, version. More example can be found in deployment
    "a_key": "A String",
  },
  "name": "A String", # Identifier. name of resource names have the form 'projects/{project_id}/workloads/{workload_id}'
  "refreshedTime": "A String", # Required. time when the workload data was refreshed
  "sapWorkload": { # The body of sap workload # The sap workload content
    "application": { # The component of sap workload # Output only. the acsc componment
      "haHosts": [ # A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
        "A String",
      ],
      "resources": [ # Output only. resources in the component
        { # The resource on GCP
          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          "name": "A String", # Output only. resource name
        },
      ],
      "sid": "A String", # Output only. sid is the sap component identificator
      "topologyType": "A String", # The detected topology of the component.
    },
    "database": { # The component of sap workload # Output only. the database componment
      "haHosts": [ # A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
        "A String",
      ],
      "resources": [ # Output only. resources in the component
        { # The resource on GCP
          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          "name": "A String", # Output only. resource name
        },
      ],
      "sid": "A String", # Output only. sid is the sap component identificator
      "topologyType": "A String", # The detected topology of the component.
    },
    "metadata": { # Output only. The metadata for SAP workload.
      "a_key": "A String",
    },
  },
  "sqlserverWorkload": { # The body of sqlserver workload # The sqlserver workload content
    "ags": [ # Output only. The availability groups for sqlserver
      { # The availability groups for sqlserver
        "databases": [ # Output only. The databases
          "A String",
        ],
        "name": "A String", # Output only. The availability group name
        "primaryServer": "A String", # Output only. The primary server
        "secondaryServers": [ # Output only. The secondary servers
          "A String",
        ],
      },
    ],
    "cluster": { # The cluster for sqlserver # Output only. The cluster for sqlserver
      "nodes": [ # Output only. The nodes
        "A String",
      ],
      "witnessServer": "A String", # Output only. The witness server
    },
    "databases": [ # Output only. The databases for sqlserver
      { # The database for sqlserver
        "backupFile": "A String", # Output only. The backup file
        "backupSchedule": "A String", # Output only. The backup schedule
        "hostVm": "A String", # Output only. The host VM
        "name": "A String", # Output only. The database name
      },
    ],
    "loadBalancerServer": { # The load balancer for sqlserver # Output only. The load balancer for sqlserver
      "ip": "A String", # Output only. The IP address
      "vm": "A String", # Output only. The VM name
    },
  },
  "state": "A String", # Output only. [output only] the current state if a a workload
  "threeTierWorkload": { # The body of three tier workload # The 3 tier web app workload content
    "apiLayer": { # The API layer server # Output only. The API layer for three tier workload
      "name": "A String", # Output only. The api layer name
      "osVersion": "A String", # Output only. OS information
      "resources": [ # Output only. resources in the component
        { # The resource on GCP
          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          "name": "A String", # Output only. resource name
        },
      ],
    },
    "backend": { # The backend server # Output only. The backend for three tier workload
      "backupFile": "A String", # Output only. The backup file
      "backupSchedule": "A String", # Output only. The backup schedule
      "name": "A String", # Output only. The backend name
      "osVersion": "A String", # Output only. OS information
      "resources": [ # Output only. resources in the component
        { # The resource on GCP
          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          "name": "A String", # Output only. resource name
        },
      ],
    },
    "endpoint": "A String", # Output only. the workload endpoint
    "frontend": { # The front end server # Output only. The frontend for three tier workload
      "name": "A String", # Output only. The frontend name
      "osVersion": "A String", # Output only. OS information
      "resources": [ # Output only. resources in the component
        { # The resource on GCP
          "kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
          "name": "A String", # Output only. resource name
        },
      ],
    },
  },
  "workloadType": "A String", # Required. The type of the workload
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List workloads

Args:
  parent: string, Required. Parent value for ListWorkloadRequest (required)
  filter: string, Optional. Filtering results
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # List workloadResponse returns a response with the list of workload overview
  "nextPageToken": "A String", # Output only. A token identifying a page of results the server should return
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
  "workloadOverviews": [ # Output only. The list of Workload Overview
    { # a workload profile overview
      "sapWorkloadOverview": { # The overview of sap workload # The sap workload overview
        "appSid": "A String", # Output only. The application SID
        "dbSid": "A String", # Output only. The database SID
        "sapSystemId": "A String", # Output only. The UUID for a SAP workload
      },
      "sqlserverWorkloadOverview": { # The overview of sqlserver workload # The sqlserver workload overview
        "availabilityGroup": [ # Output only. The availability groups
          "A String",
        ],
        "sqlserverSystemId": "A String", # Output only. The UUID for a Sqlserver workload
      },
      "threeTierWorkloadOverview": { # The overview of three tier workload # The three tier workload overview
        "threeTierSystemId": "A String", # Output only. The UUID for a three tier workload
      },
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.