Close httplib2 connections.
Get a specific policy schema for a customer by its resource name.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Gets a list of policy schemas that match a specified filter value for a given customer.
Retrieves the next page of results.
close()
Close httplib2 connections.
get(name, x__xgafv=None)
Get a specific policy schema for a customer by its resource name.
Args:
name: string, Required. The policy schema resource name to query. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Resource representing a policy schema.
"accessRestrictions": [ # Output only. Specific access restrictions related to this policy.
"A String",
],
"additionalTargetKeyNames": [ # Output only. Additional key names that will be used to identify the target of the policy value. When specifying a `policyTargetKey`, each of the additional keys specified here will have to be included in the `additionalTargetKeys` map.
{ # Additional key names that will be used to identify the target of the policy value.
"key": "A String", # Key name.
"keyDescription": "A String", # Key description.
},
],
"categoryTitle": "A String", # Title of the category in which a setting belongs.
"definition": { # Describes a complete .proto file. # Schema definition using proto descriptor.
"editionDeprecated": "A String", # BEGIN GOOGLE-INTERNAL TODO(b/297898292) Deprecate and remove this field in favor of enums. END GOOGLE-INTERNAL
"enumType": [
{ # Describes an enum type.
"name": "A String",
"value": [
{ # Describes a value within an enum.
"name": "A String",
"number": 42,
},
],
},
],
"messageType": [ # All top-level definitions in this file.
{ # Describes a message type.
"enumType": [
{ # Describes an enum type.
"name": "A String",
"value": [
{ # Describes a value within an enum.
"name": "A String",
"number": 42,
},
],
},
],
"field": [
{ # Describes a field within a message.
"defaultValue": "A String", # For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.
"jsonName": "A String", # JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
"label": "A String",
"name": "A String",
"number": 42,
"oneofIndex": 42, # If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
"proto3Optional": True or False, # If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`.
"type": "A String", # If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
"typeName": "A String", # For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
},
],
"name": "A String",
"nestedType": [
# Object with schema name: Proto2DescriptorProto
],
"oneofDecl": [
{ # Describes a oneof.
"name": "A String",
},
],
},
],
"name": "A String", # file name, relative to root of source tree
"package": "A String", # e.g. "foo", "foo.bar", etc.
"syntax": "A String", # The syntax of the proto file. The supported values are "proto2", "proto3", and "editions". If `edition` is present, this value must be "editions".
},
"fieldDescriptions": [ # Output only. Detailed description of each field that is part of the schema. Fields are suggested to be displayed by the ordering in this list, not by field number.
{ # Provides detailed information for a particular field that is part of a PolicySchema.
"defaultValue": "", # Output only. Client default if the policy is unset.
"description": "A String", # Deprecated. Use name and field_description instead. The description for the field.
"field": "A String", # Output only. The name of the field for associated with this description.
"fieldConstraints": { # Information about any range constraints. # Output only. Information on any input constraints associated on the values for the field.
"numericRangeConstraint": { # A constraint on upper and/or lower bounds, with at least one being set. # The allowed range for numeric fields.
"maximum": "A String", # Maximum value.
"minimum": "A String", # Minimum value.
},
"uploadedFileConstraints": { # Constraints on the uploaded file of a file policy. # Constraints on the uploaded file of a file policy. If present, this policy requires a URL that can be fetched by uploading a file with the constraints specified in this proto.
"sizeLimitBytes": "A String", # The size limit of uploaded files for a setting, in bytes.
"supportedContentTypes": [ # File types that can be uploaded for a setting.
"A String",
],
},
},
"fieldDependencies": [ # Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.
{ # The field and the value it must have for another field to be allowed to be set.
"sourceField": "A String", # The source field which this field depends on.
"sourceFieldValue": "A String", # The value which the source field must have for this field to be allowed to be set.
},
],
"fieldDescription": "A String", # Output only. The description of the field.
"inputConstraint": "A String", # Output only. Any input constraints associated on the values for the field.
"knownValueDescriptions": [ # Output only. If the field has a set of known values, this field will provide a description for these values.
{ # Provides detailed information about a known value that is allowed for a particular field in a PolicySchema.
"description": "A String", # Output only. Additional description for this value.
"fieldDependencies": [ # Output only. Field conditions required for this value to be valid.
{ # The field and the value it must have for another field to be allowed to be set.
"sourceField": "A String", # The source field which this field depends on.
"sourceFieldValue": "A String", # The value which the source field must have for this field to be allowed to be set.
},
],
"value": "A String", # Output only. The string represenstation of the value that can be set for the field.
},
],
"name": "A String", # Output only. The name of the field.
"nestedFieldDescriptions": [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields. Fields are suggested to be displayed by the ordering in this list, not by field number.
# Object with schema name: GoogleChromePolicyVersionsV1PolicySchemaFieldDescription
],
"requiredItems": [ # Output only. Provides a list of fields that are required to be set if this field has a certain value.
{ # The fields that will become required based on the value of this field.
"fieldConditions": [ # The value(s) of the field that provoke required field enforcement. An empty field_conditions implies that any value assigned to this field will provoke required field enforcement.
"A String",
],
"requiredFields": [ # The fields that are required as a consequence of the field conditions.
"A String",
],
},
],
},
],
"name": "A String", # Format: name=customers/{customer}/policySchemas/{schema_namespace}
"notices": [ # Output only. Special notice messages related to setting certain values in certain fields in the schema.
{ # Provides special notice messages related to a particular value in a field that is part of a PolicySchema.
"acknowledgementRequired": True or False, # Output only. Whether the user needs to acknowledge the notice message before the value can be set.
"field": "A String", # Output only. The field name associated with the notice.
"noticeMessage": "A String", # Output only. The notice message associate with the value of the field.
"noticeValue": "A String", # Output only. The value of the field that has a notice. When setting the field to this value, the user may be required to acknowledge the notice message in order for the value to be set.
},
],
"policyApiLifecycle": { # Lifecycle information. # Output only. Current lifecycle information.
"deprecatedInFavorOf": [ # In the event that this policy was deprecated in favor of another policy, the fully qualified namespace(s) of the new policies as they will show in PolicyAPI. Could only be set if policy_api_lifecycle_stage is API_DEPRECATED.
"A String",
],
"description": "A String", # Description about current life cycle.
"endSupport": { # 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 # End supporting date for current policy. Attempting to modify a policy after its end support date will result in a Bad Request (400 error). Could only be set if policy_api_lifecycle_stage is API_DEPRECATED.
"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.
},
"policyApiLifecycleStage": "A String", # Indicates current life cycle stage of the policy API.
"scheduledToDeprecatePolicies": [ # Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy.
"A String",
],
},
"policyDescription": "A String", # Output only. Description about the policy schema for user consumption.
"schemaName": "A String", # Output only. The fully qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies or BatchDeleteGroupPolicies.
"supportUri": "A String", # Output only. URI to related support article for this schema.
"supportedPlatforms": [ # Output only. List indicates that the policy will only apply to devices/users on these platforms.
"A String",
],
"validTargetResources": [ # Output only. Information about applicable target resources for the policy.
"A String",
],
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Gets a list of policy schemas that match a specified filter value for a given customer.
Args:
parent: string, Required. The customer for which the listing request will apply. (required)
filter: string, The schema filter used to find a particular schema based on fields like its resource name, description and `additionalTargetKeyNames`.
pageSize: integer, The maximum number of policy schemas to return, defaults to 100 and has a maximum of 1000.
pageToken: string, The page token used to retrieve a specific page of the listing request.
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 listing policy schemas that match a filter.
"nextPageToken": "A String", # The page token used to get the next page of policy schemas.
"policySchemas": [ # The list of policy schemas that match the query.
{ # Resource representing a policy schema.
"accessRestrictions": [ # Output only. Specific access restrictions related to this policy.
"A String",
],
"additionalTargetKeyNames": [ # Output only. Additional key names that will be used to identify the target of the policy value. When specifying a `policyTargetKey`, each of the additional keys specified here will have to be included in the `additionalTargetKeys` map.
{ # Additional key names that will be used to identify the target of the policy value.
"key": "A String", # Key name.
"keyDescription": "A String", # Key description.
},
],
"categoryTitle": "A String", # Title of the category in which a setting belongs.
"definition": { # Describes a complete .proto file. # Schema definition using proto descriptor.
"editionDeprecated": "A String", # BEGIN GOOGLE-INTERNAL TODO(b/297898292) Deprecate and remove this field in favor of enums. END GOOGLE-INTERNAL
"enumType": [
{ # Describes an enum type.
"name": "A String",
"value": [
{ # Describes a value within an enum.
"name": "A String",
"number": 42,
},
],
},
],
"messageType": [ # All top-level definitions in this file.
{ # Describes a message type.
"enumType": [
{ # Describes an enum type.
"name": "A String",
"value": [
{ # Describes a value within an enum.
"name": "A String",
"number": 42,
},
],
},
],
"field": [
{ # Describes a field within a message.
"defaultValue": "A String", # For numeric types, contains the original text representation of the value. For booleans, "true" or "false". For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.
"jsonName": "A String", # JSON name of this field. The value is set by protocol compiler. If the user has set a "json_name" option on this field, that option's value will be used. Otherwise, it's deduced from the field's name by converting it to camelCase.
"label": "A String",
"name": "A String",
"number": 42,
"oneofIndex": 42, # If set, gives the index of a oneof in the containing type's oneof_decl list. This field is a member of that oneof.
"proto3Optional": True or False, # If true, this is a proto3 "optional". When a proto3 field is optional, it tracks presence regardless of field type. When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a "synthetic" oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all "real" oneofs. For message fields, proto3_optional doesn't create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote "optional" or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can't tell if a field is a message or an enum, so it must always create a synthetic oneof. Proto2 optional fields do not set this flag, because they already indicate optional with `LABEL_OPTIONAL`.
"type": "A String", # If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
"typeName": "A String", # For message and enum types, this is the name of the type. If the name starts with a '.', it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).
},
],
"name": "A String",
"nestedType": [
# Object with schema name: Proto2DescriptorProto
],
"oneofDecl": [
{ # Describes a oneof.
"name": "A String",
},
],
},
],
"name": "A String", # file name, relative to root of source tree
"package": "A String", # e.g. "foo", "foo.bar", etc.
"syntax": "A String", # The syntax of the proto file. The supported values are "proto2", "proto3", and "editions". If `edition` is present, this value must be "editions".
},
"fieldDescriptions": [ # Output only. Detailed description of each field that is part of the schema. Fields are suggested to be displayed by the ordering in this list, not by field number.
{ # Provides detailed information for a particular field that is part of a PolicySchema.
"defaultValue": "", # Output only. Client default if the policy is unset.
"description": "A String", # Deprecated. Use name and field_description instead. The description for the field.
"field": "A String", # Output only. The name of the field for associated with this description.
"fieldConstraints": { # Information about any range constraints. # Output only. Information on any input constraints associated on the values for the field.
"numericRangeConstraint": { # A constraint on upper and/or lower bounds, with at least one being set. # The allowed range for numeric fields.
"maximum": "A String", # Maximum value.
"minimum": "A String", # Minimum value.
},
"uploadedFileConstraints": { # Constraints on the uploaded file of a file policy. # Constraints on the uploaded file of a file policy. If present, this policy requires a URL that can be fetched by uploading a file with the constraints specified in this proto.
"sizeLimitBytes": "A String", # The size limit of uploaded files for a setting, in bytes.
"supportedContentTypes": [ # File types that can be uploaded for a setting.
"A String",
],
},
},
"fieldDependencies": [ # Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.
{ # The field and the value it must have for another field to be allowed to be set.
"sourceField": "A String", # The source field which this field depends on.
"sourceFieldValue": "A String", # The value which the source field must have for this field to be allowed to be set.
},
],
"fieldDescription": "A String", # Output only. The description of the field.
"inputConstraint": "A String", # Output only. Any input constraints associated on the values for the field.
"knownValueDescriptions": [ # Output only. If the field has a set of known values, this field will provide a description for these values.
{ # Provides detailed information about a known value that is allowed for a particular field in a PolicySchema.
"description": "A String", # Output only. Additional description for this value.
"fieldDependencies": [ # Output only. Field conditions required for this value to be valid.
{ # The field and the value it must have for another field to be allowed to be set.
"sourceField": "A String", # The source field which this field depends on.
"sourceFieldValue": "A String", # The value which the source field must have for this field to be allowed to be set.
},
],
"value": "A String", # Output only. The string represenstation of the value that can be set for the field.
},
],
"name": "A String", # Output only. The name of the field.
"nestedFieldDescriptions": [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields. Fields are suggested to be displayed by the ordering in this list, not by field number.
# Object with schema name: GoogleChromePolicyVersionsV1PolicySchemaFieldDescription
],
"requiredItems": [ # Output only. Provides a list of fields that are required to be set if this field has a certain value.
{ # The fields that will become required based on the value of this field.
"fieldConditions": [ # The value(s) of the field that provoke required field enforcement. An empty field_conditions implies that any value assigned to this field will provoke required field enforcement.
"A String",
],
"requiredFields": [ # The fields that are required as a consequence of the field conditions.
"A String",
],
},
],
},
],
"name": "A String", # Format: name=customers/{customer}/policySchemas/{schema_namespace}
"notices": [ # Output only. Special notice messages related to setting certain values in certain fields in the schema.
{ # Provides special notice messages related to a particular value in a field that is part of a PolicySchema.
"acknowledgementRequired": True or False, # Output only. Whether the user needs to acknowledge the notice message before the value can be set.
"field": "A String", # Output only. The field name associated with the notice.
"noticeMessage": "A String", # Output only. The notice message associate with the value of the field.
"noticeValue": "A String", # Output only. The value of the field that has a notice. When setting the field to this value, the user may be required to acknowledge the notice message in order for the value to be set.
},
],
"policyApiLifecycle": { # Lifecycle information. # Output only. Current lifecycle information.
"deprecatedInFavorOf": [ # In the event that this policy was deprecated in favor of another policy, the fully qualified namespace(s) of the new policies as they will show in PolicyAPI. Could only be set if policy_api_lifecycle_stage is API_DEPRECATED.
"A String",
],
"description": "A String", # Description about current life cycle.
"endSupport": { # 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 # End supporting date for current policy. Attempting to modify a policy after its end support date will result in a Bad Request (400 error). Could only be set if policy_api_lifecycle_stage is API_DEPRECATED.
"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.
},
"policyApiLifecycleStage": "A String", # Indicates current life cycle stage of the policy API.
"scheduledToDeprecatePolicies": [ # Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy.
"A String",
],
},
"policyDescription": "A String", # Output only. Description about the policy schema for user consumption.
"schemaName": "A String", # Output only. The fully qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies or BatchDeleteGroupPolicies.
"supportUri": "A String", # Output only. URI to related support article for this schema.
"supportedPlatforms": [ # Output only. List indicates that the policy will only apply to devices/users on these platforms.
"A String",
],
"validTargetResources": [ # Output only. Information about applicable target resources for the policy.
"A String",
],
},
],
}
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.