create(parent, body=None, licenseConfigId=None, x__xgafv=None)

Creates a LicenseConfig

Args:
  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Information about users' licenses.
  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
    "alertEnrollments": [ # Optional. The enrollment state of each alert.
      { # The alert enrollment status.
        "alertId": "A String", # Immutable. The id of an alert.
        "enrollState": "A String", # Required. The enrollment status of a customer.
        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
          "a_key": "A String",
        },
      },
    ],
    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
    "contactDetails": [ # Optional. The contact details for each alert policy.
      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
        "emailAddress": "A String", # Optional. The email address of the contact.
      },
    ],
    "languageCode": "A String", # Optional. The language code used for notifications
  },
  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
  "licenseCount": "A String", # Required. Number of licenses purchased.
  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "state": "A String", # Output only. The state of the license config.
  "subscriptionTerm": "A String", # Required. Subscription term.
  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
}

  licenseConfigId: string, Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information about users' licenses.
  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
    "alertEnrollments": [ # Optional. The enrollment state of each alert.
      { # The alert enrollment status.
        "alertId": "A String", # Immutable. The id of an alert.
        "enrollState": "A String", # Required. The enrollment status of a customer.
        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
          "a_key": "A String",
        },
      },
    ],
    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
    "contactDetails": [ # Optional. The contact details for each alert policy.
      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
        "emailAddress": "A String", # Optional. The email address of the contact.
      },
    ],
    "languageCode": "A String", # Optional. The language code used for notifications
  },
  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
  "licenseCount": "A String", # Required. Number of licenses purchased.
  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "state": "A String", # Output only. The state of the license config.
  "subscriptionTerm": "A String", # Required. Subscription term.
  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
}

get(name, x__xgafv=None)

Gets a LicenseConfig.

Args:
  name: string, Required. Full resource name of LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/*`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information about users' licenses.
  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
    "alertEnrollments": [ # Optional. The enrollment state of each alert.
      { # The alert enrollment status.
        "alertId": "A String", # Immutable. The id of an alert.
        "enrollState": "A String", # Required. The enrollment status of a customer.
        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
          "a_key": "A String",
        },
      },
    ],
    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
    "contactDetails": [ # Optional. The contact details for each alert policy.
      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
        "emailAddress": "A String", # Optional. The email address of the contact.
      },
    ],
    "languageCode": "A String", # Optional. The language code used for notifications
  },
  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
  "licenseCount": "A String", # Required. Number of licenses purchased.
  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "state": "A String", # Output only. The state of the license config.
  "subscriptionTerm": "A String", # Required. Subscription term.
  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
}

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the LicenseConfig

Args:
  name: string, Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Information about users' licenses.
  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
    "alertEnrollments": [ # Optional. The enrollment state of each alert.
      { # The alert enrollment status.
        "alertId": "A String", # Immutable. The id of an alert.
        "enrollState": "A String", # Required. The enrollment status of a customer.
        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
          "a_key": "A String",
        },
      },
    ],
    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
    "contactDetails": [ # Optional. The contact details for each alert policy.
      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
        "emailAddress": "A String", # Optional. The email address of the contact.
      },
    ],
    "languageCode": "A String", # Optional. The language code used for notifications
  },
  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
  "licenseCount": "A String", # Required. Number of licenses purchased.
  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "state": "A String", # Output only. The state of the license config.
  "subscriptionTerm": "A String", # Required. Subscription term.
  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
}

  updateMask: string, Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information about users' licenses.
  "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
    "alertEnrollments": [ # Optional. The enrollment state of each alert.
      { # The alert enrollment status.
        "alertId": "A String", # Immutable. The id of an alert.
        "enrollState": "A String", # Required. The enrollment status of a customer.
        "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
          "a_key": "A String",
        },
      },
    ],
    "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
    "contactDetails": [ # Optional. The contact details for each alert policy.
      { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
        "emailAddress": "A String", # Optional. The email address of the contact.
      },
    ],
    "languageCode": "A String", # Optional. The language code used for notifications
  },
  "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
  "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "freeTrial": True or False, # Optional. Whether the license config is for free trial.
  "licenseCount": "A String", # Required. Number of licenses purchased.
  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
  "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  },
  "state": "A String", # Output only. The state of the license config.
  "subscriptionTerm": "A String", # Required. Subscription term.
  "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
}

Discovery Engine API . projects . locations . licenseConfigs

Instance Methods

Method Details