Cloud Product Registry API . logicalProducts . variants

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Get details of a LogicalProductVariant.

Args:
  name: string, Required. The name of the LogicalProductVariant to retrieve. Format: logicalProducts/{logical_product}/variants/{variant} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a distinct offering derived from a primary product that retains core functionalities but offers specialized features for a specific market segment.
  "lifecycleState": "A String", # Output only. Current Lifecycle state of the logical product variant.
  "name": "A String", # Identifier. The resource name of the LogicalProductVariant. Format: logicalProducts/{logical_product}/variants/{variant}
  "replaced": True or False, # Output only. Indicates whether the logical product variant has been replaced. If `false`, the variant is active. If `true`, the variant has been replaced by another type, and the `replacement` field contains the resource name of that replacement.
  "replacement": "A String", # Output only. The resource name of the Logical Entity that the logical product variant is replaced by. This field is only populated when this logical product variant is replaced by some other type. Eg: logicalProducts/{logical_product}, productSuites/{product_suite}, etc.
  "title": "A String", # Display name of the LogicalProductVariant.
}

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

Lists LogicalProductVariants matching given criteria.

Args:
  parent: string, Required. Parent logical product id. Format: logicalProducts/{logical_product} (required)
  pageSize: integer, Optional. The maximum number of logical product variants to return. The service may return fewer than this value. If unspecified, at most 100 logical product variants will be returned. The maximum value is 500; values above 500 will be coerced to 500.
  pageToken: string, Optional. A page token, received from a previous `ListLogicalProductVariants` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLogicalProductVariants` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListLogicalProductVariants.
  "logicalProductVariants": [ # Matched LogicalProductVariants
    { # Represents a distinct offering derived from a primary product that retains core functionalities but offers specialized features for a specific market segment.
      "lifecycleState": "A String", # Output only. Current Lifecycle state of the logical product variant.
      "name": "A String", # Identifier. The resource name of the LogicalProductVariant. Format: logicalProducts/{logical_product}/variants/{variant}
      "replaced": True or False, # Output only. Indicates whether the logical product variant has been replaced. If `false`, the variant is active. If `true`, the variant has been replaced by another type, and the `replacement` field contains the resource name of that replacement.
      "replacement": "A String", # Output only. The resource name of the Logical Entity that the logical product variant is replaced by. This field is only populated when this logical product variant is replaced by some other type. Eg: logicalProducts/{logical_product}, productSuites/{product_suite}, etc.
      "title": "A String", # Display name of the LogicalProductVariant.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

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.
        

lookupEntity(lookupUri, x__xgafv=None)

Look up entities.

Args:
  lookupUri: string, Required. Entity uri to look up. Supported Formats: logicalProducts/{logical_product} logicalProducts/{logical_product}/variants/{variant} productSuites/{product_suite} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for LookupEntity.
  "logicalProduct": { # Represents an independent service offering that can be provisioned by a customer. # Matched LogicalProduct.
    "lifecycleState": "A String", # Output only. Current Lifecycle state of the logical product.
    "name": "A String", # Identifier. The resource name of the LogicalProduct. Format: logicalProducts/{logical_product}.
    "productSuite": "A String", # Product suite associated with the logical product. Format: productSuites/{product_suite}.
    "replaced": True or False, # Output only. Indicates whether the logical product has been replaced. If `false`, the product is active. If `true`, the product has been replaced by another type, and the `replacement` field contains the resource name of that replacement.
    "replacement": "A String", # Output only. The resource name of the Logical Entity that the logical product is replaced by. This field is only populated when this logical product is replaced by some other type. Eg: logicalProducts/{logical_product}/variants/{variant}, productSuites/{product_suite}, etc.
    "title": "A String", # Display name of the LogicalProduct.
    "variants": [ # Output only. Child variant resource references. Format: logicalProducts/{logical_product}/variants/{variant}
      "A String",
    ],
  },
  "logicalProductVariant": { # Represents a distinct offering derived from a primary product that retains core functionalities but offers specialized features for a specific market segment. # Matched LogicalProductVariant.
    "lifecycleState": "A String", # Output only. Current Lifecycle state of the logical product variant.
    "name": "A String", # Identifier. The resource name of the LogicalProductVariant. Format: logicalProducts/{logical_product}/variants/{variant}
    "replaced": True or False, # Output only. Indicates whether the logical product variant has been replaced. If `false`, the variant is active. If `true`, the variant has been replaced by another type, and the `replacement` field contains the resource name of that replacement.
    "replacement": "A String", # Output only. The resource name of the Logical Entity that the logical product variant is replaced by. This field is only populated when this logical product variant is replaced by some other type. Eg: logicalProducts/{logical_product}, productSuites/{product_suite}, etc.
    "title": "A String", # Display name of the LogicalProductVariant.
  },
  "productSuite": { # Represents a unified grouping of products sharing a common brand and market positioning. # Matched ProductSuite.
    "logicalProducts": [ # Output only. LogicalProducts under this suite. Format: logicalProducts/{logical_product}
      "A String",
    ],
    "name": "A String", # Identifier. The resource name of the ProductSuite. Format: productSuites/{product_suite}
    "replaced": True or False, # Output only. Indicates whether the product suite has been replaced. If `false`, the product suite is active. If `true`, the product suite has been replaced by another type, and the `replacement` field contains the resource name of that replacement.
    "replacement": "A String", # Output only. The resource name of the Logical Entity that the product suite is replaced by. This field is only populated when this product suite is replaced by some other type. Eg: logicalProducts/{logical_product}, logicalProducts/{logical_product}/variants/{variant}, etc.
    "title": "A String", # Title of the ProductSuite.
  },
}