Class ResourcePolicy (1.56.0)

public final class ResourcePolicy extends GeneratedMessageV3 implements ResourcePolicyOrBuilder

Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.

Protobuf type google.cloud.compute.v1.ResourcePolicy

Static Fields

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISK_CONSISTENCY_GROUP_POLICY_FIELD_NUMBER

public static final int DISK_CONSISTENCY_GROUP_POLICY_FIELD_NUMBER
Field Value
Type Description
int

GROUP_PLACEMENT_POLICY_FIELD_NUMBER

public static final int GROUP_PLACEMENT_POLICY_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_SCHEDULE_POLICY_FIELD_NUMBER

public static final int INSTANCE_SCHEDULE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_STATUS_FIELD_NUMBER

public static final int RESOURCE_STATUS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_SCHEDULE_POLICY_FIELD_NUMBER

public static final int SNAPSHOT_SCHEDULE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResourcePolicy getDefaultInstance()
Returns
Type Description
ResourcePolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ResourcePolicy.Builder newBuilder()
Returns
Type Description
ResourcePolicy.Builder

newBuilder(ResourcePolicy prototype)

public static ResourcePolicy.Builder newBuilder(ResourcePolicy prototype)
Parameter
Name Description
prototype ResourcePolicy
Returns
Type Description
ResourcePolicy.Builder

parseDelimitedFrom(InputStream input)

public static ResourcePolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResourcePolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ResourcePolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ResourcePolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ResourcePolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ResourcePolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ResourcePolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ResourcePolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ResourcePolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResourcePolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ResourcePolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ResourcePolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourcePolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ResourcePolicy> parser()
Returns
Type Description
Parser<ResourcePolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public ResourcePolicy getDefaultInstanceForType()
Returns
Type Description
ResourcePolicy

getDescription()

public String getDescription()

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDiskConsistencyGroupPolicy()

public ResourcePolicyDiskConsistencyGroupPolicy getDiskConsistencyGroupPolicy()

Resource policy for disk consistency groups.

optional .google.cloud.compute.v1.ResourcePolicyDiskConsistencyGroupPolicy disk_consistency_group_policy = 473727515;

Returns
Type Description
ResourcePolicyDiskConsistencyGroupPolicy

The diskConsistencyGroupPolicy.

getDiskConsistencyGroupPolicyOrBuilder()

public ResourcePolicyDiskConsistencyGroupPolicyOrBuilder getDiskConsistencyGroupPolicyOrBuilder()

Resource policy for disk consistency groups.

optional .google.cloud.compute.v1.ResourcePolicyDiskConsistencyGroupPolicy disk_consistency_group_policy = 473727515;

Returns
Type Description
ResourcePolicyDiskConsistencyGroupPolicyOrBuilder

getGroupPlacementPolicy()

public ResourcePolicyGroupPlacementPolicy getGroupPlacementPolicy()

Resource policy for instances for placement configuration.

optional .google.cloud.compute.v1.ResourcePolicyGroupPlacementPolicy group_placement_policy = 10931596;

Returns
Type Description
ResourcePolicyGroupPlacementPolicy

The groupPlacementPolicy.

getGroupPlacementPolicyOrBuilder()

public ResourcePolicyGroupPlacementPolicyOrBuilder getGroupPlacementPolicyOrBuilder()

Resource policy for instances for placement configuration.

optional .google.cloud.compute.v1.ResourcePolicyGroupPlacementPolicy group_placement_policy = 10931596;

Returns
Type Description
ResourcePolicyGroupPlacementPolicyOrBuilder

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getInstanceSchedulePolicy()

public ResourcePolicyInstanceSchedulePolicy getInstanceSchedulePolicy()

Resource policy for scheduling instance operations.

optional .google.cloud.compute.v1.ResourcePolicyInstanceSchedulePolicy instance_schedule_policy = 344877104;

Returns
Type Description
ResourcePolicyInstanceSchedulePolicy

The instanceSchedulePolicy.

getInstanceSchedulePolicyOrBuilder()

public ResourcePolicyInstanceSchedulePolicyOrBuilder getInstanceSchedulePolicyOrBuilder()

Resource policy for scheduling instance operations.

optional .google.cloud.compute.v1.ResourcePolicyInstanceSchedulePolicy instance_schedule_policy = 344877104;

Returns
Type Description
ResourcePolicyInstanceSchedulePolicyOrBuilder

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#resource_policies for resource policies.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#resource_policies for resource policies.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public String getName()

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ResourcePolicy> getParserForType()
Returns
Type Description
Parser<ResourcePolicy>
Overrides

getRegion()

public String getRegion()

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

getResourceStatus()

public ResourcePolicyResourceStatus getResourceStatus()

[Output Only] The system status of the resource policy.

optional .google.cloud.compute.v1.ResourcePolicyResourceStatus resource_status = 249429315;

Returns
Type Description
ResourcePolicyResourceStatus

The resourceStatus.

getResourceStatusOrBuilder()

public ResourcePolicyResourceStatusOrBuilder getResourceStatusOrBuilder()

[Output Only] The system status of the resource policy.

optional .google.cloud.compute.v1.ResourcePolicyResourceStatus resource_status = 249429315;

Returns
Type Description
ResourcePolicyResourceStatusOrBuilder
public String getSelfLink()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSnapshotSchedulePolicy()

public ResourcePolicySnapshotSchedulePolicy getSnapshotSchedulePolicy()

Resource policy for persistent disks for creating snapshots.

optional .google.cloud.compute.v1.ResourcePolicySnapshotSchedulePolicy snapshot_schedule_policy = 218131295;

Returns
Type Description
ResourcePolicySnapshotSchedulePolicy

The snapshotSchedulePolicy.

getSnapshotSchedulePolicyOrBuilder()

public ResourcePolicySnapshotSchedulePolicyOrBuilder getSnapshotSchedulePolicyOrBuilder()

Resource policy for persistent disks for creating snapshots.

optional .google.cloud.compute.v1.ResourcePolicySnapshotSchedulePolicy snapshot_schedule_policy = 218131295;

Returns
Type Description
ResourcePolicySnapshotSchedulePolicyOrBuilder

getStatus()

public String getStatus()

[Output Only] The status of resource policy creation. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

[Output Only] The status of resource policy creation. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDiskConsistencyGroupPolicy()

public boolean hasDiskConsistencyGroupPolicy()

Resource policy for disk consistency groups.

optional .google.cloud.compute.v1.ResourcePolicyDiskConsistencyGroupPolicy disk_consistency_group_policy = 473727515;

Returns
Type Description
boolean

Whether the diskConsistencyGroupPolicy field is set.

hasGroupPlacementPolicy()

public boolean hasGroupPlacementPolicy()

Resource policy for instances for placement configuration.

optional .google.cloud.compute.v1.ResourcePolicyGroupPlacementPolicy group_placement_policy = 10931596;

Returns
Type Description
boolean

Whether the groupPlacementPolicy field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasInstanceSchedulePolicy()

public boolean hasInstanceSchedulePolicy()

Resource policy for scheduling instance operations.

optional .google.cloud.compute.v1.ResourcePolicyInstanceSchedulePolicy instance_schedule_policy = 344877104;

Returns
Type Description
boolean

Whether the instanceSchedulePolicy field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#resource_policies for resource policies.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasRegion()

public boolean hasRegion()

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

hasResourceStatus()

public boolean hasResourceStatus()

[Output Only] The system status of the resource policy.

optional .google.cloud.compute.v1.ResourcePolicyResourceStatus resource_status = 249429315;

Returns
Type Description
boolean

Whether the resourceStatus field is set.

public boolean hasSelfLink()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSnapshotSchedulePolicy()

public boolean hasSnapshotSchedulePolicy()

Resource policy for persistent disks for creating snapshots.

optional .google.cloud.compute.v1.ResourcePolicySnapshotSchedulePolicy snapshot_schedule_policy = 218131295;

Returns
Type Description
boolean

Whether the snapshotSchedulePolicy field is set.

hasStatus()

public boolean hasStatus()

[Output Only] The status of resource policy creation. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ResourcePolicy.Builder newBuilderForType()
Returns
Type Description
ResourcePolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ResourcePolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ResourcePolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ResourcePolicy.Builder toBuilder()
Returns
Type Description
ResourcePolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException